Skip to main content

Credentials

Credentials belong to users and allow them to sign into the platform, creating temporary sessions. They consist of a handle and a password.

Sessions provide short-lived bearer tokens, which in turn can be used to authenticate API requests.

Expiration: The bearer tokens associated with sessions are short-lived and will expire 24 hours after they are generated.

To learn how to use the token of a session to authenticate your API requests, read the bearer tokens page.

Access: Only you can update your credentials.

 

Fields​

    tokenstringrequired

    The Base64-encoded bearer token of the session. Is unique.

    Format: jwt
    Example: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1c2VyLWEifQ.Enz9YR7aZ9fulmBm9qVP7hA
    issuedAtstringrequired

    The date and time when the session was issued.

    Format: date-time
    Example: 2023-01-01T00:00:00.000000Z
    expiresAtstringrequired

    The date and time when the session expires.

    Format: date-time
    Example: 2023-01-02T00:00:00.000000Z
Session
{
  "token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1c2VyLWEifQ.Enz9YR7aZ9fulmBm9qVP7hA",
  "issuedAt": "2023-01-01T00:00:00.000000Z",
  "expiresAt": "2023-01-02T00:00:00.000000Z"
}