Sign in

v1

latestOpenAPI 3.1.02026-07-23310383.1 KB
External Users

Authenticates an external user.

post/api/v1/external-users/authenticate

Headers

authorizationstring required

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Request body

channelIdstring uuid required

A UUID v4 string that identifies an entity.

externalIdstring nullable required
idstring uuid nullable required

A UUID v4 string that identifies an entity.

identifierstring nullable required

Response

The external user was authenticated and access token generated.

createdAtstring date-time required
idstring uuid required

A UUID v4 string that identifies an entity.

updatedAtstring date-time required
blockedboolean required

Whether the external user is blocked.

channelIdstring uuid required

The ID of the channel associated with the external user.

externalIdstring nullable required

External reference in the integrated system.

externalUserGroupIdstring uuid nullable required

The ID of the external user group associated with the external user.

identifierstring nullable required

A unique identifier of the external user (usernames, emails, phone numbers and etc).

namestring nullable required

The display name of the external user.

superIdentityIdstring uuid required

The ID of the super identity associated with the external user.

tierIdstring uuid nullable required

The ID of the tier associated with the external user.

workspaceIdstring uuid required

The ID of the workspace associated with the external user.

accessTokenstring required