organizations
identity_provider_configs

post/api/organizations/{organization_id}/identity_provider_configs/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/organizations/{organization_id}/identity_provider_configs/
  • 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

idstring uuid required
namestring

Display name for this IdP configuration (e.g. 'Okta production').

organization_domain_idsstring[]

Organization domain IDs that this identity provider configuration applies to.

created_atstring date-time required
updated_atstring date-time required
has_samlboolean required

Whether SAML is fully configured on this config.

has_oidcboolean required

Whether OIDC has an issuer, client ID, and client secret.

has_oidc_client_secretboolean required

Whether an encrypted OIDC client secret is saved.

oidc_client_idstring

Client ID of the organization's OIDC application.

oidc_client_secretstring

OIDC client secret. Omit to keep the saved secret. Set to an empty string to remove it. Never returned in responses.

saml_relay_statestring required

Stable UUID sent as SAML RelayState to route authentication responses to this IdP configuration.

saml_entity_idstring nullable

SAML IdP entity ID (issuer).

saml_acs_urlstring nullable

SAML single sign-on (ACS) URL the IdP redirects to.

saml_x509_certstring nullable

SAML IdP X.509 signing certificate (PEM).

has_scimboolean required

Whether SCIM is enabled and a bearer token is set on this config.

scim_enabledboolean

Whether SCIM provisioning is enabled. Setting this true generates a bearer token (returned once); setting it false clears the token.

scim_base_urlstring required

SCIM base URL for this identity provider configuration.

scim_bearer_tokenstring nullable required

Plaintext SCIM bearer token. Only returned once, immediately after SCIM is enabled or the token is regenerated; null otherwise.

has_id_jagboolean required

Whether ID-JAG (XAA) is configured on this config.

id_jag_issuer_urlstring nullable

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

id_jag_jwks_urlstring nullable

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

id_jag_allowed_clientsstring[]

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

Response

idstring uuid required
namestring

Display name for this IdP configuration (e.g. 'Okta production').

organization_domain_idsstring[]

Organization domain IDs that this identity provider configuration applies to.

created_atstring date-time required
updated_atstring date-time required
has_samlboolean required

Whether SAML is fully configured on this config.

has_oidcboolean required

Whether OIDC has an issuer, client ID, and client secret.

has_oidc_client_secretboolean required

Whether an encrypted OIDC client secret is saved.

oidc_client_idstring

Client ID of the organization's OIDC application.

oidc_client_secretstring

OIDC client secret. Omit to keep the saved secret. Set to an empty string to remove it. Never returned in responses.

saml_relay_statestring required

Stable UUID sent as SAML RelayState to route authentication responses to this IdP configuration.

saml_entity_idstring nullable

SAML IdP entity ID (issuer).

saml_acs_urlstring nullable

SAML single sign-on (ACS) URL the IdP redirects to.

saml_x509_certstring nullable

SAML IdP X.509 signing certificate (PEM).

has_scimboolean required

Whether SCIM is enabled and a bearer token is set on this config.

scim_enabledboolean

Whether SCIM provisioning is enabled. Setting this true generates a bearer token (returned once); setting it false clears the token.

scim_base_urlstring required

SCIM base URL for this identity provider configuration.

scim_bearer_tokenstring nullable required

Plaintext SCIM bearer token. Only returned once, immediately after SCIM is enabled or the token is regenerated; null otherwise.

has_id_jagboolean required

Whether ID-JAG (XAA) is configured on this config.

id_jag_issuer_urlstring nullable

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

id_jag_jwks_urlstring nullable

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

id_jag_allowed_clientsstring[]

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

Changes

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