Managed Service for Elasticsearch API, REST: Auth.listProviders
Retrieves the list of registered auth providers for Elasticsearch cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-elasticsearch/v1/clusters/{clusterId}/auth/providers
Path parameters
Parameter | Description |
---|---|
clusterId | Required. Required. ID of the ElasticSearch cluster. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"providers": [
{
"type": "string",
"name": "string",
"order": "string",
"enabled": true,
"hidden": true,
"description": "string",
"hint": "string",
"icon": "string",
"saml": {
"idpEntityId": "string",
"idpMetadataFile": "string",
"spEntityId": "string",
"kibanaUrl": "string",
"attributePrincipal": "string",
"attributeGroups": "string",
"attributeName": "string",
"attributeEmail": "string",
"attributeDn": "string"
}
}
]
}
Field | Description |
---|---|
providers[] | object List of auth providers of the Elasticsearch cluster. |
providers[]. type |
string |
providers[]. name |
string The maximum string length in characters is 50. Value must match the regular expression |
providers[]. order |
string (int64) |
providers[]. enabled |
boolean (boolean) |
providers[]. hidden |
boolean (boolean) selector ui settings |
providers[]. description |
string The maximum string length in characters is 50. |
providers[]. hint |
string The maximum string length in characters is 250. |
providers[]. icon |
string The maximum string length in characters is 250. |
providers[]. saml |
object |
providers[]. saml. idpEntityId |
string The maximum string length in characters is 250. |
providers[]. saml. idpMetadataFile |
string (byte) The maximum string length in characters is 10000. |
providers[]. saml. spEntityId |
string The maximum string length in characters is 250. |
providers[]. saml. kibanaUrl |
string The maximum string length in characters is 250. |
providers[]. saml. attributePrincipal |
string The maximum string length in characters is 50. |
providers[]. saml. attributeGroups |
string The maximum string length in characters is 50. |
providers[]. saml. attributeName |
string The maximum string length in characters is 50. |
providers[]. saml. attributeEmail |
string The maximum string length in characters is 50. |
providers[]. saml. attributeDn |
string The maximum string length in characters is 50. |