Identity and Access Management API, REST: UserAccount.Get
Returns the specified UserAccount resource.
HTTP request
GET https://iam.api.cloud.yandex.net/iam/v1/userAccounts/{userAccountId}
Path parameters
|
Field |
Description |
|
userAccountId |
string Required field. ID of the UserAccount resource to return. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
// Includes only one of the fields `yandexPassportUserAccount`, `samlUserAccount`
"yandexPassportUserAccount": {
"login": "string",
"defaultEmail": "string"
},
"samlUserAccount": {
"federationId": "string",
"nameId": "string",
"attributes": "object"
},
// end of the list of possible fields
"lastAuthenticatedAt": "string"
}
Currently represents only Yandex account.
|
Field |
Description |
|
id |
string ID of the user account. |
|
yandexPassportUserAccount |
A YandexPassportUserAccount resource. Includes only one of the fields |
|
samlUserAccount |
A SAML federated user. Includes only one of the fields |
|
lastAuthenticatedAt |
string (date-time) 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 |
YandexPassportUserAccount
A YandexPassportUserAccount resource.
For more information, see Yandex account.
|
Field |
Description |
|
login |
string Login of the Yandex user account. |
|
defaultEmail |
string Default email of the Yandex user account. |
SamlUserAccount
A SAML federated user.
For more information, see federations.
|
Field |
Description |
|
federationId |
string Required field. ID of the federation that the federation belongs to. The maximum string length in characters is 50. |
|
nameId |
string Required field. Name Id of the SAML federated user. The string length in characters must be 1-256. |
|
attributes |
object (map<string, Attribute>) Additional attributes of the SAML federated user. |
Attribute
|
Field |
Description |
|
value[] |
string |