docs/classes/management.SDK.IdentitiesClient.html
new IdentitiesClient(options: BaseClientOptions): IdentitiesClient
link(
id: string,
request?: LinkUserIdentityRequestContent,
requestOptions?: IdentitiesClient.RequestOptions,
): HttpResponsePromise<UserIdentity[]>
Link two user accounts together forming a primary and secondary relationship. On successful linking, the endpoint returns the new array of the primary account identities.
Note: There are two ways of invoking the endpoint:
update:current_user_identities scope:POST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities
Authorization: "Bearer PRIMARY_ACCOUNT_JWT"
{
"link_with": "SECONDARY_ACCOUNT_JWT"
}
In this case, only the link_with param is required in the body, which also contains the JWT obtained upon the secondary account's authentication.
update:users scope:POST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities
Authorization: "Bearer YOUR_API_V2_TOKEN"
{
"provider": "SECONDARY_ACCOUNT_PROVIDER",
"connection_id": "SECONDARY_ACCOUNT_CONNECTION_ID(OPTIONAL)",
"user_id": "SECONDARY_ACCOUNT_USER_ID"
}
In this case you need to send provider and user_id in the body. Optionally you can also send the connection_id param which is suitable for identifying a particular database connection for the 'auth0' provider.
ID of the primary user account to link a second user account to.
OptionalrequestOptions: IdentitiesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.users.identities.link("id")Copy
delete(
id: string,
provider: Management.UserIdentityProviderEnum,
user_id: string,
requestOptions?: IdentitiesClient.RequestOptions,
): HttpResponsePromise<DeleteUserIdentityResponseContent>
Unlink a specific secondary account from a target user. This action requires the ID of both the target user and the secondary account.
Unlinking the secondary account removes it from the identities array of the target user and creates a new standalone profile for the secondary account. To learn more, review Unlink User Accounts.
ID of the primary user account.
Identity provider name of the secondary linked account (e.g. google-oauth2).
ID of the secondary linked account (e.g. 123456789081523216417 part after the | in google-oauth2|123456789081523216417).
OptionalrequestOptions: IdentitiesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.users.identities.delete("id", "ad", "user_id")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods linkdelete Properties _options