KEkeycardai
External Sync Tokens

Create external sync token

Changed on

Creates a token an identity provider can use to provision users into this zone over SCIM. The zone must have external_sync_enabled set and a user_identity_provider_id configured; otherwise the request fails with 400.

The token value is returned only in this response and cannot be retrieved later. Multiple tokens can be active at once: to rotate, create a new token, then delete the old one.

post/zones/{zoneId}/external-sync-tokens

Request

  • Base URL
    https://docs.keycard.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://docs.keycard.ai/zones/{zoneId}/external-sync-tokens
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: /service-account-token

Path parameters

zoneIdstring required

Zone ID

Response

A new external sync token, including the token value. The value is returned only in this response.

idstring required

Unique identifier of the token

organization_idstring required

Organization that owns this token

zone_idstring required

Zone this token provisions users into

provider_idstring required

Identity provider this token provisions users for

last_used_atstring date-time nullable required

When the token was last used. null if it has never been used.

created_atstring date-time required

Entity creation timestamp

updated_atstring date-time required

Entity update timestamp

tokenstring required

The token value to configure in the identity provider. Returned only when the token is created.

Changes