Skip to main content
DELETE
Invalidate User's 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

Embed token invalidated successfully.

user_id
string

The external ID of the user

Example:

"customer_123"

organization_id
integer | null

Present when one scoped viewer relationship was invalidated

Example:

123

message
string
Example:

"Embed token invalidated successfully"

rotation_scope
enum<string>

Present when invalidation rotates signing authority for every provisioned organization of the user

Available options:
user