Managed Service for Elasticsearch API, gRPC: AuthService
A set of methods for managing Elasticsearch Authentication resources.
Call | Description |
---|---|
ListProviders | Retrieves the list of registered auth providers for Elasticsearch cluster. |
GetProvider | Returns registered auth provider by name. |
AddProviders | Adds new auth providers to Elasticsearch cluster. |
UpdateProviders | Replase the list of auth providers. |
DeleteProviders | Removes auth providers from Elasticsearch cluster by name. |
UpdateProvider | Updates registered auth provider. |
DeleteProvider | Removes auth provider from Elasticsearch cluster by name. |
Calls AuthService
ListProviders
Retrieves the list of registered auth providers for Elasticsearch cluster.
rpc ListProviders (ListAuthProvidersRequest) returns (ListAuthProvidersResponse)
ListAuthProvidersRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the ElasticSearch cluster. The maximum string length in characters is 50. |
ListAuthProvidersResponse
Field | Description |
---|---|
providers[] | AuthProvider List of auth providers of the Elasticsearch cluster. |
AuthProvider
Field | Description |
---|---|
type | enum Type |
name | string The maximum string length in characters is 50. Value must match the regular expression [a-z][a-z0-9_-]* . |
order | int64 |
enabled | bool |
hidden | bool selector ui settings |
description | string The maximum string length in characters is 50. |
hint | string The maximum string length in characters is 250. |
icon | string The maximum string length in characters is 250. |
settings | oneof: saml |
saml | SamlSettings |
SamlSettings
Field | Description |
---|---|
idp_entity_id | string The maximum string length in characters is 250. |
idp_metadata_file | bytes The maximum string length in characters is 10000. |
sp_entity_id | string The maximum string length in characters is 250. |
kibana_url | string The maximum string length in characters is 250. |
attribute_principal | string The maximum string length in characters is 50. |
attribute_groups | string The maximum string length in characters is 50. |
attribute_name | string The maximum string length in characters is 50. |
attribute_email | string The maximum string length in characters is 50. |
attribute_dn | string The maximum string length in characters is 50. |
GetProvider
Returns registered auth provider by name.
rpc GetProvider (GetAuthProviderRequest) returns (AuthProvider)
GetAuthProviderRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the ElasticSearch cluster. The maximum string length in characters is 50. |
name | string Required. Required. Name of the provider to delete. The maximum string length in characters is 50. Value must match the regular expression [a-z][a-z0-9_-]* . |
AuthProvider
Field | Description |
---|---|
type | enum Type |
name | string The maximum string length in characters is 50. Value must match the regular expression [a-z][a-z0-9_-]* . |
order | int64 |
enabled | bool |
hidden | bool selector ui settings |
description | string The maximum string length in characters is 50. |
hint | string The maximum string length in characters is 250. |
icon | string The maximum string length in characters is 250. |
settings | oneof: saml |
saml | SamlSettings |
SamlSettings
Field | Description |
---|---|
idp_entity_id | string The maximum string length in characters is 250. |
idp_metadata_file | bytes The maximum string length in characters is 10000. |
sp_entity_id | string The maximum string length in characters is 250. |
kibana_url | string The maximum string length in characters is 250. |
attribute_principal | string The maximum string length in characters is 50. |
attribute_groups | string The maximum string length in characters is 50. |
attribute_name | string The maximum string length in characters is 50. |
attribute_email | string The maximum string length in characters is 50. |
attribute_dn | string The maximum string length in characters is 50. |
AddProviders
Adds new auth providers to Elasticsearch cluster.
rpc AddProviders (AddAuthProvidersRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:AddAuthProvidersMetadata
Operation.response:AuthProviders
AddAuthProvidersRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the ElasticSearch cluster. The maximum string length in characters is 50. |
providers[] | AuthProvider Required. List of providers to add. The maximum number of elements is 10. |
AuthProvider
Field | Description |
---|---|
type | enum Type |
name | string The maximum string length in characters is 50. Value must match the regular expression [a-z][a-z0-9_-]* . |
order | int64 |
enabled | bool |
hidden | bool selector ui settings |
description | string The maximum string length in characters is 50. |
hint | string The maximum string length in characters is 250. |
icon | string The maximum string length in characters is 250. |
settings | oneof: saml |
saml | SamlSettings |
SamlSettings
Field | Description |
---|---|
idp_entity_id | string The maximum string length in characters is 250. |
idp_metadata_file | bytes The maximum string length in characters is 10000. |
sp_entity_id | string The maximum string length in characters is 250. |
kibana_url | string The maximum string length in characters is 250. |
attribute_principal | string The maximum string length in characters is 50. |
attribute_groups | string The maximum string length in characters is 50. |
attribute_name | string The maximum string length in characters is 50. |
attribute_email | string The maximum string length in characters is 50. |
attribute_dn | string The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
AddAuthProvidersMetadata
Field | Description |
---|---|
cluster_id | string ID of the ElasticSearch cluster. |
names[] | string Names of the providers being added. |
AuthProviders
Field | Description |
---|---|
providers[] | AuthProvider |
UpdateProviders
Replase the list of auth providers.
rpc UpdateProviders (UpdateAuthProvidersRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateAuthProvidersMetadata
Operation.response:AuthProviders
UpdateAuthProvidersRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the ElasticSearch cluster. The maximum string length in characters is 50. |
providers[] | AuthProvider Required. List of providers to set. The maximum number of elements is 10. |
AuthProvider
Field | Description |
---|---|
type | enum Type |
name | string The maximum string length in characters is 50. Value must match the regular expression [a-z][a-z0-9_-]* . |
order | int64 |
enabled | bool |
hidden | bool selector ui settings |
description | string The maximum string length in characters is 50. |
hint | string The maximum string length in characters is 250. |
icon | string The maximum string length in characters is 250. |
settings | oneof: saml |
saml | SamlSettings |
SamlSettings
Field | Description |
---|---|
idp_entity_id | string The maximum string length in characters is 250. |
idp_metadata_file | bytes The maximum string length in characters is 10000. |
sp_entity_id | string The maximum string length in characters is 250. |
kibana_url | string The maximum string length in characters is 250. |
attribute_principal | string The maximum string length in characters is 50. |
attribute_groups | string The maximum string length in characters is 50. |
attribute_name | string The maximum string length in characters is 50. |
attribute_email | string The maximum string length in characters is 50. |
attribute_dn | string The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateAuthProvidersMetadata
Field | Description |
---|---|
cluster_id | string ID of the ElasticSearch cluster. |
names[] | string Names of the providers being added. |
AuthProviders
Field | Description |
---|---|
providers[] | AuthProvider |
DeleteProviders
Removes auth providers from Elasticsearch cluster by name.
rpc DeleteProviders (DeleteAuthProvidersRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteAuthProvidersMetadata
Operation.response:google.protobuf.Empty
DeleteAuthProvidersRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the ElasticSearch cluster. The maximum string length in characters is 50. |
provider_names[] | string Required. List of providers to delete. The maximum number of elements is 10. The maximum string length in characters for each value is 50. Each value must match the regular expression [a-z][a-z0-9_-]* . |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteAuthProvidersMetadata
Field | Description |
---|---|
cluster_id | string ID of the ElasticSearch cluster. |
names[] | string Names of the providers being removed. |
UpdateProvider
Updates registered auth provider.
rpc UpdateProvider (UpdateAuthProviderRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateAuthProvidersMetadata
Operation.response:AuthProviders
UpdateAuthProviderRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the ElasticSearch cluster. The maximum string length in characters is 50. |
name | string Required. Required. Name of the provider to update. The maximum string length in characters is 50. Value must match the regular expression [a-z][a-z0-9_-]* . |
provider | AuthProvider Required. Required. New provider defenition. |
AuthProvider
Field | Description |
---|---|
type | enum Type |
name | string The maximum string length in characters is 50. Value must match the regular expression [a-z][a-z0-9_-]* . |
order | int64 |
enabled | bool |
hidden | bool selector ui settings |
description | string The maximum string length in characters is 50. |
hint | string The maximum string length in characters is 250. |
icon | string The maximum string length in characters is 250. |
settings | oneof: saml |
saml | SamlSettings |
SamlSettings
Field | Description |
---|---|
idp_entity_id | string The maximum string length in characters is 250. |
idp_metadata_file | bytes The maximum string length in characters is 10000. |
sp_entity_id | string The maximum string length in characters is 250. |
kibana_url | string The maximum string length in characters is 250. |
attribute_principal | string The maximum string length in characters is 50. |
attribute_groups | string The maximum string length in characters is 50. |
attribute_name | string The maximum string length in characters is 50. |
attribute_email | string The maximum string length in characters is 50. |
attribute_dn | string The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateAuthProvidersMetadata
Field | Description |
---|---|
cluster_id | string ID of the ElasticSearch cluster. |
names[] | string Names of the providers being added. |
AuthProviders
Field | Description |
---|---|
providers[] | AuthProvider |
DeleteProvider
Removes auth provider from Elasticsearch cluster by name.
rpc DeleteProvider (DeleteAuthProviderRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteAuthProvidersMetadata
Operation.response:google.protobuf.Empty
DeleteAuthProviderRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the ElasticSearch cluster. The maximum string length in characters is 50. |
name | string Required. Required. Name of the provider to delete. The maximum string length in characters is 50. Value must match the regular expression [a-z][a-z0-9_-]* . |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteAuthProvidersMetadata
Field | Description |
---|---|
cluster_id | string ID of the ElasticSearch cluster. |
names[] | string Names of the providers being removed. |