Managed Service for Elasticsearch API, gRPC: UserService.List
Retrieves the list of Elasticsearch users in the specified cluster.
gRPC request
rpc List (ListUsersRequest) returns (ListUsersResponse)
ListUsersRequest
{
"clusterId": "string",
"pageSize": "int64",
"pageToken": "string"
}
|
Field |
Description |
|
clusterId |
string Required field. ID of the Elasticsearch cluster to list Elasticsearch users in. To get the cluster ID, use a ClusterService.List request. |
|
pageSize |
int64 The maximum number of results per page to return. If the number of available results is larger than |
|
pageToken |
string Page token. To get the next page of results, set |
ListUsersResponse
{
"users": [
{
"name": "string",
"clusterId": "string"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
users[] |
List of Elasticsearch users. |
|
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results is larger than ListUsersRequest.pageSize, use the |
User
An Elasticsearch user.
|
Field |
Description |
|
name |
string Name of the Elasticsearch user. |
|
clusterId |
string ID of the Elasticsearch cluster the user belongs to. |