Skip Navigation Links

Linked Identities

Endpoint Overview

GET /api/admin/users/v4/users/identity-providers

List linkable identity providers

GET /api/admin/users/v4/users/{user_id}/linked-identities

List linked identities for user

POST /api/admin/users/v4/users/{user_id}/linked-identities

Link identity to user

DELETE /api/admin/users/v4/users/{user_id}/linked-identities/{provider_id}

Delete linked identity

List linkable identity providers

Requires authentication via bearer.

Provides a list of configured identity providers that can be linked to a user.

Response Body

200 OK

List linked identities for user

Requires authentication via bearer.

Lists all identities of remote identity providers linked to a user.

Path Params

user_id stringrequired

Unique identifier of a user.

Query Params

embed string[]

Options for embedding additional data in linked identities list responses:

ACTIONS: Include available actions for each identity (delete) and list-level actions (create)

Response Body

200 OK

Link identity to user

Requires authentication via bearer.

Links an identity of a remote identity provider to a user.

Right now a user may only be linked to one identity provider at a time. Trying to link an additional identity provider will fail with a BAD_REQUEST (status code 400) and the error code USER_ALREADY_LINKED.

Path Params

user_id stringrequired

Unique identifier of a user.

Query Params

embed string[]

Options for embedding additional data in single linked identity responses:

ACTIONS: Include available actions for the linked identity (delete)

Request Body

provider_id stringrequired

Identifier of the linked identity provider. This is the unique alias assigned to the identity provider during configuration.

linked_user_id stringrequired

Identifier of the user in the linked identity provider. This is typically the user's unique ID or object ID in the external identity system.

linked_username stringrequired

Username of the user in the linked identity provider. This is typically the user's login name or email address in the external identity system.

Response Body

200 OK

201 Created

Error Codes

INVALID_IDENTITY_PROVIDER
USER_ALREADY_LINKED

Delete linked identity

Requires authentication via bearer.

Deletes a linked identity of a remote identity provider from a user.

Path Params

user_id stringrequired

Unique identifier of a user.

provider_id stringrequired

Identifier of the linked identity provider. This is the unique alias assigned to the identity provider during configuration.

Response Body

200 OK