v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

users

Create a user

Requires user:create scope.

post/users

Request body

clientUserIdstring

Optional Id specified by API client on user's creation

Example request

{
  "clientUserId": "b3f118e8-93ce-4fa0-814a-7a7d8f6e1d9"
}

Response

Successful User Response

userIdstring required

User Id

clientUserIdstring required

Id specified by API client on user's creation

clientIdstring uuid required

API client Id that created the user

createdAtstring date-time required

The date the user was created

updatedAtstring date-time required

The date the user was last updated

scopesstring required

Scope used when the user was created

managedBy'user' | 'client' required

Represents how the user was created. Managed by client means that the api client created the user before hand according our second use case. Managed by user means that the user was created automatically when creating a connection according our first use case

lastAccessedstring nullable required

The date the user was last accessed. This property gets updated everytime a token is issued for this user

deletedAtstring nullable

The date the user was deleted

userType'test' | 'demo' | 'live' required

The type of user

clientNamestring

Name of the api client that created the user

connectionIdsstring[] required

List of connection ids for the user

Example response

{
  "userId": "6017e13d58c06e66ad39af16",
  "clientUserId": "b3f118e8-93ce-4fa0-814a-7a7d8f6e1d9",
  "clientId": "b68594a4-aa8c-4d92-ae1d-f39d9d6cc7ec",
  "createdAt": "2021-02-01T11:08:45.574Z",
  "updatedAt": "2021-02-02T11:08:45.574Z",
  "scopes": "user:create",
  "managedBy": "client",
  "lastAccessed": "2021-02-01T11:08:45.574Z",
  "deletedAt": "2021-02-01T11:08:45.574Z",
  "userType": "test",
  "clientName": "My API client",
  "connectionIds": [
    "5233db2a04fe41dd01d3308ea92e8bd7:b67c778c-1f31-48e3-a5f5-67e61d604a30"
  ]
}