Cloud Organization API, REST: User.listMembers
List organization active members.
HTTP request
GET https://organization-manager.api.cloud.yandex.net/organization-manager/v1/organizations/{organizationId}/users
Path parameters
Parameter | Description |
---|---|
organizationId | Required. ID of the Organization resource to list members for. The maximum string length in characters is 50. |
Query parameters
Parameter | Description |
---|---|
pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
pageToken | Page token. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. The maximum string length in characters is 2000. |
Response
HTTP Code: 200 - OK
{
"users": [
{
"subjectClaims": {
"sub": "string",
"name": "string",
"givenName": "string",
"familyName": "string",
"preferredUsername": "string",
"picture": "string",
"email": "string",
"zoneinfo": "string",
"locale": "string",
"phoneNumber": "string",
"subType": "string",
"federation": {
"id": "string",
"name": "string"
},
"lastAuthenticatedAt": "string"
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
users[] | object List of users for the specified organization. |
users[]. subjectClaims |
object OpenID standard claims with additional Cloud Organization claims. Claims representation, see https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims for details. |
users[]. subjectClaims. sub |
string Required. Subject - Identifier for the End-User at the Issuer. The maximum string length in characters is 50. |
users[]. subjectClaims. name |
string End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences. |
users[]. subjectClaims. givenName |
string Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters. |
users[]. subjectClaims. familyName |
string Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters. |
users[]. subjectClaims. preferredUsername |
string Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7. |
users[]. subjectClaims. picture |
string URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User. |
users[]. subjectClaims. |
string End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7. |
users[]. subjectClaims. zoneinfo |
string String from zoneinfo |
users[]. subjectClaims. locale |
string End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639-1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166-1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well. |
users[]. subjectClaims. phoneNumber |
string End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678. |
users[]. subjectClaims. subType |
string Subject type. |
users[]. subjectClaims. federation |
object User federation, non-empty only for federated users. Minimalistic analog of yandex.cloud.organizationmanager.v1.saml.Federation |
users[]. subjectClaims. federation. id |
string Required. ID of the federation. The maximum string length in characters is 50. |
users[]. subjectClaims. federation. name |
string Name of the federation. The name is unique within the cloud or organization |
users[]. subjectClaims. lastAuthenticatedAt |
string (date-time) Last time the access token was created. Filled only for federated users (not for global users). 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |