Skip Navigation Links

Linked Identities

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[]

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[]

Request Body

provider_id stringrequired

Identifier of the linked identity provider.

linked_user_id stringrequired

Identifier of the user in the linked identity provider.

linked_username stringrequired

Username of the user in the linked identity provider.

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.

Response Body

200 OK