Sign in

v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB
Admin Portal Link Tokens

Create an Admin Portal Link Token

post/admin_portal_link_tokens

Request body

organization_idstring
it_contact_idstring
scopesstring[]
seconds_until_expirationinteger

Response

201 Created

object'admin_portal_link_token' required
idstring required
admin_portal_link_idstring required

The origin-level admin_portal_link this token was issued for.

instance_idstring required
organization_idstring nullable required

Optional. Present only when the link is scoped to an existing org.

it_contact_idstring nullable required

Optional opaque reference to the IT contact associated with this link.

scopesstring[] nullable required

Caller-provided scopes for this token.

tokenstring required

The single-use admin portal link token. Returned only on creation. URL-borne; treat as a secret.

revokedboolean required
revocation_reasonstring nullable required
expiredboolean required
expirationnumber nullable required

The timestamp for when the token will expire, in milliseconds.

created_atnumber required

The timestamp for when the token was created, in milliseconds.

updated_atnumber required

The timestamp for when the token was last updated, in milliseconds.

Example response

{
  "id": "aplt_3beecc9c60adb5f9b850e91a83beecc9",
  "admin_portal_link_id": "apl_3beecc9c60adb5f9b850e91a8d2",
  "instance_id": "ins_2xhFjEI5X2qWRvtV13BzSj8H6Dk",
  "organization_id": "org_2xhFjEI5X2qWRvtV13BzSj8H6Dk",
  "it_contact_id": "usr_abc123",
  "scopes": [
    "admin_portal:read"
  ],
  "token": "aplt_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "revocation_reason": "Revoked by user",
  "expiration": 1716883200000,
  "created_at": 1716883200000,
  "updated_at": 1716883200000
}