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
Field |
Description |
organizationId |
string Required field. ID of the Organization resource to list members for. |
Query parameters
Field |
Description |
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. Set |
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[] |
List of users for the specified organization. |
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results |
OrganizationUser
Field |
Description |
subjectClaims |
OpenID standard claims with additional Cloud Organization claims. |
SubjectClaims
Claims representation, see https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims for details.
Field |
Description |
sub |
string Required field. Subject - Identifier for the End-User at the Issuer. |
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. |
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. |
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. |
preferredUsername |
string Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. |
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), |
|
string End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. |
zoneinfo |
string String from zoneinfo |
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. |
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. |
subType |
enum (SubjectType) Subject type.
|
federation |
User federation, non-empty only for federated users. |
lastAuthenticatedAt |
string (date-time) Last time the access token was created. Filled only for federated users (not for global users). String in RFC3339 To work with values in this field, use the APIs described in the |
Federation
Minimalistic analog of yandex.cloud.organizationmanager.v1.saml.Federation
Field |
Description |
id |
string Required field. ID of the federation. |
name |
string Name of the federation. The name is unique within the cloud or organization |