Users, REST: User.List
List users in a specific folder.
HTTP request
GET https://rest-assistant.api.cloud.yandex.net/users/v1/users
Query parameters
Request message for listing users in a specific folder.
|
Field |
Description |
|
folderId |
string Required field. Folder ID from which to list users. |
|
pageSize |
string (int64) Maximum number of users to return per page. |
|
pageToken |
string Token to retrieve the next page of results. |
Response
HTTP Code: 200 - OK
{
"users": [
{
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"source": "string",
"createdBy": "string",
"createdAt": "string",
"updatedBy": "string",
"updatedAt": "string",
"expirationConfig": {
"expirationPolicy": "string",
"ttlDays": "string"
},
"expiresAt": "string",
"labels": "object"
}
],
"nextPageToken": "string"
}
Response message for the list operation.
|
Field |
Description |
|
users[] |
List of users in the specified folder. |
|
nextPageToken |
string Token to retrieve the next page of results. |
User
|
Field |
Description |
|
id |
string Unique identifier of the user. |
|
folderId |
string ID of the folder that the user belongs to. |
|
name |
string Name of the user. |
|
description |
string Description of the user. |
|
source |
string |
|
createdBy |
string Identifier of the subject who created this user. |
|
createdAt |
string (date-time) Timestamp representing when the user was created. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
updatedBy |
string Identifier of the subject who last updated this user. |
|
updatedAt |
string (date-time) Timestamp representing the last time this user was updated. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
expirationConfig |
Configuration for the expiration of the user, defining when and how the user will expire. |
|
expiresAt |
string (date-time) Timestamp representing when the user will expire. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
labels |
object (map<string, string>) Set of key-value pairs that can be used to organize and categorize the user. |
ExpirationConfig
|
Field |
Description |
|
expirationPolicy |
enum (ExpirationPolicy)
|
|
ttlDays |
string (int64) |