Managed Service for Elasticsearch API, gRPC: UserService
A set of methods for managing Elasticsearch users.
Call | Description |
---|---|
Get | Returns the specified Elasticsearch user. |
List | Retrieves the list of Elasticsearch users in the specified cluster. |
Create | Creates a user in the specified cluster. |
Update | Updates the specified user. |
Delete | Deletes the specified user. |
Calls UserService
Get
Returns the specified Elasticsearch user.
To get the list of available Elasticsearch users, make a List request.
rpc Get (GetUserRequest) returns (User)
GetUserRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster the user belongs to. To get the cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
user_name | string Required. Name of the Elasticsearch user to return. To get the name of the user, make a UserService.List request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]* . |
User
Field | Description |
---|---|
name | string Name of the Elasticsearch user. |
cluster_id | string ID of the Elasticsearch cluster the user belongs to. |
List
Retrieves the list of Elasticsearch users in the specified cluster.
rpc List (ListUsersRequest) returns (ListUsersResponse)
ListUsersRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster to list Elasticsearch users in. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListUsersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListUsersResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListUsersResponse
Field | Description |
---|---|
users[] | User List of Elasticsearch users. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListUsersRequest.page_size, use the next_page_token as the value for the ListUsersRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
User
Field | Description |
---|---|
name | string Name of the Elasticsearch user. |
cluster_id | string ID of the Elasticsearch cluster the user belongs to. |
Create
Creates a user in the specified cluster.
rpc Create (CreateUserRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateUserMetadata
Operation.response:User
CreateUserRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster to create a user in. To get the cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
user_spec | UserSpec Required. Configuration of the user to create. |
UserSpec
Field | Description |
---|---|
name | string Required. Name of the Elasticsearch user. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]* . |
password | string Required. Password of the Elasticsearch user. The string length in characters must be 8-128. |
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. |
CreateUserMetadata
Field | Description |
---|---|
cluster_id | string ID of the Elasticsearch cluster the user is being created in. |
user_name | string Name of the user that is being created. |
User
Field | Description |
---|---|
name | string Name of the Elasticsearch user. |
cluster_id | string ID of the Elasticsearch cluster the user belongs to. |
Update
Updates the specified user.
rpc Update (UpdateUserRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateUserMetadata
Operation.response:User
UpdateUserRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster the user belongs to. To get the cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
user_name | string Required. Name of the user to be updated. To get the name of the user, make a UserService.List request. The string length in characters must be 1-63. Value must match the regular expression [a-zA-Z0-9_]* . |
update_mask | google.protobuf.FieldMask |
password | string New password for the user. The string length in characters must be 8-128. |
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. |
UpdateUserMetadata
Field | Description |
---|---|
cluster_id | string ID of the Elasticsearch cluster the user belongs to. |
user_name | string Name of the user that is being updated. |
User
Field | Description |
---|---|
name | string Name of the Elasticsearch user. |
cluster_id | string ID of the Elasticsearch cluster the user belongs to. |
Delete
Deletes the specified user.
rpc Delete (DeleteUserRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteUserMetadata
Operation.response:google.protobuf.Empty
DeleteUserRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster the user belongs to. To get the cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
user_name | string Required. Name of the user to delete. To get the name of the user, make a UserService.List request. The string length in characters must be 1-63. Value must match the regular expression [a-zA-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. |
DeleteUserMetadata
Field | Description |
---|---|
cluster_id | string ID of the Elasticsearch cluster the user belongs to. |
user_name | string Name of the user that is being deleted. |