Contact UsGet started

Managed Service for Elasticsearch API, REST: User.List

Written by
Updated at October 17, 2024

Retrieves the list of Elasticsearch users in the specified cluster.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-elasticsearch/v1/clusters/{clusterId}/users

Path parameters

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.

Query parameters

Field

Description

pageSize

string (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.nextPageToken that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token.

To get the next page of results, set page_token to the ListUsersResponse.nextPageToken returned by the previous list request.

Response

HTTP Code: 200 - OK

{
  "users": [
    {
      "name": "string",
      "clusterId": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

users[]

User

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 next_page_token as the value for the ListUsersRequest.pageToken parameter in the next list request.
Each subsequent list request will have its own next_page_token to continue paging through the results.

User

An Elasticsearch user.

Field

Description

name

string

Name of the Elasticsearch user.

clusterId

string

ID of the Elasticsearch cluster the user belongs to.
Previous
Get
Next
Create