Skip to main content

GetByLogin

Returns the specified YandexPassportUserAccount resource.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const GetUserAccountByLoginRequest =
cloudApi.iam.yandex_passport_user_account_service
.GetUserAccountByLoginRequest;

(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(
serviceClients.YandexPassportUserAccountServiceClient
);

const result = await client.getByLogin(
GetUserAccountByLoginRequest.fromPartial({
login: "login",
})
);
console.log(result);
})();

GetUserAccountByLoginRequest

login : string

Login of the YandexPassportUserAccount resource to return.

UserAccount

Currently represents only Yandex account.

id : string

ID of the user account.

One of userAccount

  • yandexPassportUserAccount : YandexPassportUserAccount

    A YandexPassportUserAccount resource.

  • samlUserAccount : SamlUserAccount

    A SAML federated user.

YandexPassportUserAccount

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

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.

Attribute
value : string
federationId : string

ID of the federation that the federation belongs to.

nameId : string

Name Id of the SAML federated user. The name is unique within the federation. 1-256 characters long.

attributes : Attribute

Additional attributes of the SAML federated user.

Attribute

value : string