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
| Parameter | Description |
|---|---|
| userAccountId | Required. 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
}
Currently represents only Yandex account.
| Field | Description |
|---|---|
| id | string ID of the user account. |
| yandexPassportUserAccount | object A YandexPassportUserAccount resource. includes only one of the fields yandexPassportUserAccount, samlUserAccount |
| yandexPassportUserAccount. login |
string Login of the Yandex user account. |
| yandexPassportUserAccount. defaultEmail |
string Default email of the Yandex user account. |
| samlUserAccount | object A SAML federated user. includes only one of the fields yandexPassportUserAccount, samlUserAccount |
| samlUserAccount. federationId |
string Required. ID of the federation that the federation belongs to. The maximum string length in characters is 50. |
| samlUserAccount. nameId |
string Required. Name Id of the SAML federated user. The name is unique within the federation. 1-256 characters long. The string length in characters must be 1-256. |
| samlUserAccount. attributes |
object Additional attributes of the SAML federated user. |