UserAccount

A set of methods for managing user accounts. Currently applicable only for Yandex.Passport accounts.

JSON Representation

{
  "id": "string",

  //  includes only one of the fields `yandexPassportUserAccount`, `samlUserAccount`
  "yandexPassportUserAccount": {
    "login": "string",
    "defaultEmail": "string"
  },
  "samlUserAccount": {
    "federationId": "string",
    "nameId": "string"
  },
  // end of the list of possible fields

}
Field Description
id string

ID of the user account.

yandexPassportUserAccount object
includes only one of the fields yandexPassportUserAccount, samlUserAccount

A YandexPassportUserAccount resource. For more information, see Yandex.Passport account.

yandexPassportUserAccount.
login
string

Login of the Yandex.Passport user account.

yandexPassportUserAccount.
defaultEmail
string

Default email of the Yandex.Passport user account.

samlUserAccount object
includes only one of the fields yandexPassportUserAccount, samlUserAccount

A SAML federated user. For more information, see federations.

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.

Methods

Method Description
get Returns the specified UserAccount resource.