organizations
cimd_verification_tokens

Manage CIMD verification tokens for an organization.

A partner embeds the plaintext token in their CIMD metadata document as verification_token inside the com.posthog object (the legacy top-level posthog_verification_token field still works as a fallback). When PostHog fetches the metadata, matching the token links the partner app to this organization and grants a higher default rate limit for account provisioning.

Each token is scoped at creation to the one cimd_url it will be published at, and verifies nowhere else. Two organizations may name the same URL; only the one whose token is actually served there verifies, so claiming a URL cannot be used to block a partner from verifying theirs.

The plaintext value is only available on creation; we store a hash.

post/api/organizations/{organization_id}/cimd_verification_tokens/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/organizations/{organization_id}/cimd_verification_tokens/
  • Auth: HTTP bearer

Path parameters

organization_idstring required

ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.

Request body

labelstring required

Human-readable name to identify this token later, e.g. 'Production CIMD partner'.

cimd_urlstring required

HTTPS URL of the CIMD metadata document this token will be published in. The token only verifies at this URL, so a copy hosted anywhere else is rejected. Host case, an explicit :443 and a trailing slash are normalized away; the path is case-sensitive.

Response

idstring uuid required
labelstring required

Human-readable name to identify this token later, e.g. 'Production CIMD partner'.

cimd_urlstring nullable required

HTTPS URL of the CIMD metadata document this token verifies at. Null on tokens issued before URL binding; those no longer verify until bound via PATCH or reissued.

mask_valuestring nullable required
created_atstring date-time required
last_used_atstring date-time nullable required
valuestring required

Plaintext token, only returned on creation

Changes

No recorded changes to this operation across all 1 revision of this API.