Skip to main content
POST
Generate New Embed Token

Authorizations

X-API-KEY
string
header
required

Path Parameters

external_id
string
required

The external ID of the user

Query Parameters

organization_id
integer

Selects one organization context. Required when the user can access more than one eligible context, and recommended for every scoped viewer request.

Required range: x >= 1

Response

New embed token generated successfully.

embed_token
string

The user's new embed token (URL-safe, compact format)

Example:

"MTIzNDV8ZDgyZDk3Mzg1OTAxNTkzNA"

user_id
string

The external ID of the user

Example:

"customer_123"

organization_id
integer | null

Present for an organization-scoped viewer token

Example:

123

message
string
Example:

"New embed token generated successfully"

rotation_scope
enum<string>

Present when rotation invalidates all provisioned-organization compact tokens for the user

Available options:
user