Sign-in Tokens

Create sign-in token

Creates a new sign-in token and associates it with the given user. By default, sign-in tokens expire in 30 days. You can optionally supply a different duration in seconds using the expires_in_seconds property.

post/sign_in_tokens

Request body

user_idstring required

The ID of the user that can use the newly created sign in token

org_idstring nullable

The ID of the organization to activate when the user signs in. Organizations must be enabled for the instance, and the user must be a member of the organization.

expires_in_secondsinteger nullable

Optional parameter to specify the life duration of the sign in token in seconds. By default, the duration is 30 days.

Response

Success

object'sign_in_token' required
idstring required
status'pending' | 'accepted' | 'revoked' required
user_idstring required
tokenstring
urlstring nullable
created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

Changes

Changed in 1 of the 15 revisions of this API.2

    • added the new optional request property

      new-optional-request-property

    • added the non-success response with the status

      response-non-success-status-added