Managed Service for OpenSearch API, gRPC: ClusterService.GetAuthSettings
Retrieves auth settings for specified cluster.
gRPC request
rpc GetAuthSettings (GetAuthSettingsRequest) returns (AuthSettings)
GetAuthSettingsRequest
{
"cluster_id": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. Required. ID of the OpenSearch cluster. The maximum string length in characters is 50. |
AuthSettings
{
"saml": {
"enabled": "bool",
"idp_entity_id": "string",
"idp_metadata_file": "bytes",
"sp_entity_id": "string",
"dashboards_url": "string",
"roles_key": "string",
"subject_key": "string",
"jwt_default_expiration_timeout": "google.protobuf.Int64Value"
}
}
|
Field |
Description |
|
saml |
SAML settings |
SAMLSettings
|
Field |
Description |
|
enabled |
bool |
|
idp_entity_id |
string Required. The entity ID of your IdP. The maximum string length in characters is 250. |
|
idp_metadata_file |
bytes Required. The SAML 2.0 metadata file of your IdP. The maximum string length in characters is 10000. |
|
sp_entity_id |
string Required. The entity ID of the service provider. The maximum string length in characters is 250. |
|
dashboards_url |
string Required. The OpenSearch Dashboards base URL. The maximum string length in characters is 250. |
|
roles_key |
string Optional. The attribute in the SAML response where the roles are stored. If not configured, no roles are used. The maximum string length in characters is 250. |
|
subject_key |
string Optional. The attribute in the SAML response where the subject is stored. If not configured, the NameID attribute is used. The maximum string length in characters is 250. |
|
jwt_default_expiration_timeout |
default jwt expiration timeout. |