provider organizationsdomains PUT /api/organizations/{organization_id}/domains/{id}/
@utdk/posthog /api/organizations/{organization_id}/domains/{id}/
domains_update
id path required
A UUID string identifying this domain.
string
organization_id path required
ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
string

Try it

Authentication
Configure credentials for PostHog API
domainsUpdate
PUT/api/organizations/{organization_id}/domains/{id}/

Parameters

required

A UUID string identifying this domain.

required

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

Input

required
required
required

Determines whether a domain is verified or not.

required
required
required

Returns whether SAML is configured for the instance. Does not validate the user has the required license (that check is performed in other places).

SAML IdP entity ID (issuer).

SAML single sign-on (ACS) URL.

SAML IdP X.509 signing certificate (PEM).

required

Returns whether SCIM is configured and enabled for this domain.

Whether SCIM provisioning is enabled for this domain.

required
required
required

Returns whether ID-JAG (XAA) is configured for this domain.

Trusted IdP issuer URL for ID-JAG (XAA). Required to enable ID-JAG on this domain.

Override JWKS URL. Defaults to OIDC discovery on the issuer URL.

Allowed ID-JAG client IDs. Empty list allows any client_id.

Linked IdP configuration (SAML/SCIM/XAA) that backs this domain. Must belong to the same organization.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.domainsUpdate()