Skip to main content

Generate a temporal access token

POST 
/v1/auth/login

Generate temporal access token using a specific user's credentials

Request​

Body

required

User credentials to be used for login

    email emailrequired

    The email of the organization user as registered in the records.

    password passwordrequired

    The password of the organization user as registered in the records.

    sub_account_id number

    The ID of the sub-account to be used for this login. This is only required when the user's organization has multiple sub-accounts. NB: The list of available sub-accounts for a user's organization (if applicable and available) can be retrieved by making the request without this parameter (sub_account_id).

Responses​

Success

Schema
    oneOf
    sub_account_id_required boolean

    This is set to true if user's organization has multiple sub-accounts that can be accessed and a sub-account ID was not given in the request body.

    sub_accounts object[]

    An array of available sub-accounts for the user's organization.

  • Array [
    • id integer

    The ID of the organization sub-account.

    name string

    The name of the organization sub-account.

  • ]
Loading...