v1

latestOpenAPI 3.1.02026-07-264793109.1 KB
1. Authentication

Create Component Token

Authenticate on behalf of an end user by supplying their external user ID.

This endpoint is used by authenticated API clients to create a user-scoped access token for a specific end user (referenced by their external ID) in the API client's organisation. If no such end user exists, one will be created on demand.

Returns a bearer access token scoped to this end user upon success.

This token is site-scoped and valid for 24 hours, longer-lived than the standard organisation token (1 hour) as it is intended for end-user sessions.

post/auth/component-token

Response

Successfully authenticated with a user-scoped access token

idstring uuid required
access_tokenstring required
token_typestring required
All 47 operations