POST
/
o
/
{organisation_id}
/
users
Create an End User
curl --request POST \
  --url https://platform.versori.com/api/v2/o/{organisation_id}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "externalId": "<string>",
  "displayName": "<string>"
}'
{
  "id": "<string>",
  "externalId": "<string>",
  "displayName": "<string>",
  "organisationId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.

Path Parameters

​
organisation_id
string<ulid>
required

Body

application/json

Request to create a new End User

​
externalId
string
required

ExternalID is the identifier of the user

​
displayName
string

DisplayName is a human-readable name for the user

Response

Created

​
id
string<ulid>
required

ID is the Versori identifier for the user. Most APIs will not use this field but instead reference users by their externalId.

​
externalId
string
required

ExternalID is the identifier for the user as determined by the organisation. This typically should be the same as the user's ID on the organisations system. Regardless of the value, it must be unique within the Organisation.

​
displayName
string
required

DisplayName is an optional human-readable name for the user. If not set, the default is an empty string.

​
organisationId
string<ulid>
required

The organisation ID to which the user belongs to.

​
createdAt
string<date-time>
required

CreatedAt is the time the user was created.

​
updatedAt
string<date-time>
required

UpdatedAt is the time the user was last updated.