Authentication

Create Basic Token

POST https://{organisation}.clearlrs.com/api/auth/basic

Inserts new Basic Authentication credentials for a given actor that can be used to make further API requests on behalf of the actor.

Request Body

NameTypeDescription

username

string

Username for Basic Auth credentials. Must be unique ofr every set of new credentials.

password

string

Password to be used for these Basic Auth credentials.

ttlMins

number

The length of time these credentials will be active before expiry.

data

object

Optional data to store against these credentials, can include the following properties: actor – will restrict these credentials to the same level of permissions as the supplied actor.

{
  "username": "uuid"
}

Last updated