Managed Service for Elasticsearch API, gRPC: AuthService.ListProviders
Written by
Updated at November 26, 2024
Retrieves the list of registered auth providers for Elasticsearch cluster.
gRPC request
rpc ListProviders (ListAuthProvidersRequest) returns (ListAuthProvidersResponse)
ListAuthProvidersRequest
{
"cluster_id": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. Required. ID of the ElasticSearch cluster. |
ListAuthProvidersResponse
{
"providers": [
{
"type": "Type",
"name": "string",
"order": "int64",
"enabled": "bool",
"hidden": "bool",
"description": "string",
"hint": "string",
"icon": "string",
// Includes only one of the fields `saml`
"saml": {
"idp_entity_id": "string",
"idp_metadata_file": "bytes",
"sp_entity_id": "string",
"kibana_url": "string",
"attribute_principal": "string",
"attribute_groups": "string",
"attribute_name": "string",
"attribute_email": "string",
"attribute_dn": "string"
}
// end of the list of possible fields
}
]
}
|
Field |
Description |
|
providers[] |
List of auth providers of the Elasticsearch cluster. |
AuthProvider
|
Field |
Description |
|
type |
enum Type
|
|
name |
string |
|
order |
int64 |
|
enabled |
bool |
|
hidden |
bool selector ui settings |
|
description |
string |
|
hint |
string |
|
icon |
string |
|
saml |
Includes only one of the fields |
SamlSettings
|
Field |
Description |
|
idp_entity_id |
string |
|
idp_metadata_file |
bytes |
|
sp_entity_id |
string |
|
kibana_url |
string |
|
attribute_principal |
string |
|
attribute_groups |
string |
|
attribute_name |
string |
|
attribute_email |
string |
|
attribute_dn |
string |