Managed Service for Elasticsearch API, gRPC: AuthService.UpdateProvider
Updates registered auth provider.
gRPC request
rpc UpdateProvider (UpdateAuthProviderRequest) returns (operation.Operation)
UpdateAuthProviderRequest
{
"clusterId": "string",
"name": "string",
"provider": {
"type": "Type",
"name": "string",
"order": "int64",
"enabled": "bool",
"hidden": "bool",
"description": "string",
"hint": "string",
"icon": "string",
// Includes only one of the fields `saml`
"saml": {
"idpEntityId": "string",
"idpMetadataFile": "bytes",
"spEntityId": "string",
"kibanaUrl": "string",
"attributePrincipal": "string",
"attributeGroups": "string",
"attributeName": "string",
"attributeEmail": "string",
"attributeDn": "string"
}
// end of the list of possible fields
}
}
Field |
Description |
clusterId |
string Required field. Required. ID of the ElasticSearch cluster. |
name |
string Required field. Required. Name of the provider to update. |
provider |
Required field. Required. New provider defenition. |
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 |
idpEntityId |
string |
idpMetadataFile |
bytes |
spEntityId |
string |
kibanaUrl |
string |
attributePrincipal |
string |
attributeGroups |
string |
attributeName |
string |
attributeEmail |
string |
attributeDn |
string |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"clusterId": "string",
"names": [
"string"
]
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"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": {
"idpEntityId": "string",
"idpMetadataFile": "bytes",
"spEntityId": "string",
"kibanaUrl": "string",
"attributePrincipal": "string",
"attributeGroups": "string",
"attributeName": "string",
"attributeEmail": "string",
"attributeDn": "string"
}
// end of the list of possible fields
}
]
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateAuthProvidersMetadata
Field |
Description |
clusterId |
string ID of the ElasticSearch cluster. |
names[] |
string Names of the providers being added. |
AuthProviders
Field |
Description |
providers[] |
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 |
idpEntityId |
string |
idpMetadataFile |
bytes |
spEntityId |
string |
kibanaUrl |
string |
attributePrincipal |
string |
attributeGroups |
string |
attributeName |
string |
attributeEmail |
string |
attributeDn |
string |