Domains API Reference

Domains

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

`GET`
`POST`
`GET`
`PATCH`
`DELETE`
`GET`
`POST`
`POST`

List all domains

Required API key scopes

organization:read

Path parameters

organization_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/organizations/:organization_id/domains
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/domains/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/organizations/{organization_id}/domains/".format(
        project_id=project_id,
		organization_id="<the organization id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "domain": "string",
      "is_verified": true,
      "verified_at": "2019-08-24T14:15:22Z",
      "verification_challenge": "string",
      "jit_provisioning_enabled": true,
      "sso_enforcement": "string",
      "has_saml": true,
      "saml_entity_id": "string",
      "saml_acs_url": "string",
      "saml_x509_cert": "string",
      "has_scim": true,
      "scim_enabled": true,
      "scim_base_url": "string",
      "scim_bearer_token": "string"
    }
  ]
}

Create domains

Required API key scopes

organization:write

Path parameters

organization_id
string

Request parameters

domain
string
jit_provisioning_enabled
boolean
sso_enforcement
string
saml_entity_id
string
saml_acs_url
string
saml_x509_cert
string
scim_enabled
boolean

Response

Example request

POST /api/organizations/:organization_id/domains
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/domains/\
	-d domain="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/organizations/{organization_id}/domains/".format(
        project_id=project_id,
		organization_id="<the organization id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"domain": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "is_verified": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "verification_challenge": "string",
  "jit_provisioning_enabled": true,
  "sso_enforcement": "string",
  "has_saml": true,
  "saml_entity_id": "string",
  "saml_acs_url": "string",
  "saml_x509_cert": "string",
  "has_scim": true,
  "scim_enabled": true,
  "scim_base_url": "string",
  "scim_bearer_token": "string"
}

Retrieve domains

Required API key scopes

organization:read

Path parameters

id
string
organization_id
string

Response

Example request

GET /api/organizations/:organization_id/domains/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/domains/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/organizations/{organization_id}/domains/{domain_id}/".format(
        project_id=project_id,
		domain_id="<the domain id>",
		organization_id="<the organization id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "is_verified": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "verification_challenge": "string",
  "jit_provisioning_enabled": true,
  "sso_enforcement": "string",
  "has_saml": true,
  "saml_entity_id": "string",
  "saml_acs_url": "string",
  "saml_x509_cert": "string",
  "has_scim": true,
  "scim_enabled": true,
  "scim_base_url": "string",
  "scim_bearer_token": "string"
}

Update domains

Required API key scopes

organization:write

Path parameters

id
string
organization_id
string

Request parameters

domain
string
jit_provisioning_enabled
boolean
sso_enforcement
string
saml_entity_id
string
saml_acs_url
string
saml_x509_cert
string
scim_enabled
boolean

Response

Example request

PATCH /api/organizations/:organization_id/domains/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/domains/:id/\
	-d domain="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/organizations/{organization_id}/domains/{domain_id}/".format(
        project_id=project_id,
		domain_id="<the domain id>",
		organization_id="<the organization id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"domain": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "is_verified": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "verification_challenge": "string",
  "jit_provisioning_enabled": true,
  "sso_enforcement": "string",
  "has_saml": true,
  "saml_entity_id": "string",
  "saml_acs_url": "string",
  "saml_x509_cert": "string",
  "has_scim": true,
  "scim_enabled": true,
  "scim_base_url": "string",
  "scim_bearer_token": "string"
}

Delete domains

Required API key scopes

organization:write

Path parameters

id
string
organization_id
string

Example request

DELETE /api/organizations/:organization_id/domains/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/domains/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/organizations/{organization_id}/domains/{domain_id}/".format(
        project_id=project_id,
		domain_id="<the domain id>",
		organization_id="<the organization id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Retrieve domains scim logs

Path parameters

id
string
organization_id
string

Example request

GET /api/organizations/:organization_id/domains/:id/scim/logs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/domains/:id/scim/logs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/organizations/{organization_id}/domains/{domain_id}/scim/logs/".format(
        project_id=project_id,
		domain_id="<the domain id>",
		organization_id="<the organization id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create domains scim token

Regenerate SCIM bearer token.

Path parameters

id
string
organization_id
string

Request parameters

domain
string
jit_provisioning_enabled
boolean
sso_enforcement
string
saml_entity_id
string
saml_acs_url
string
saml_x509_cert
string
scim_enabled
boolean

Example request

POST /api/organizations/:organization_id/domains/:id/scim/token
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/domains/:id/scim/token/\
	-d domain="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/organizations/{organization_id}/domains/{domain_id}/scim/token/".format(
        project_id=project_id,
		domain_id="<the domain id>",
		organization_id="<the organization id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"domain": "string"
	}
).json()

Example response

Status 200 No response body

Create domains verify

Path parameters

id
string
organization_id
string

Request parameters

domain
string
jit_provisioning_enabled
boolean
sso_enforcement
string
saml_entity_id
string
saml_acs_url
string
saml_x509_cert
string
scim_enabled
boolean

Example request

POST /api/organizations/:organization_id/domains/:id/verify
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/domains/:id/verify/\
	-d domain="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/organizations/{organization_id}/domains/{domain_id}/verify/".format(
        project_id=project_id,
		domain_id="<the domain id>",
		organization_id="<the organization id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"domain": "string"
	}
).json()

Domains

Endpoints

List all domains

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create domains

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve domains

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update domains

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete domains

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Retrieve domains scim logs

Path parameters

Example request

Example response

Status 200 No response body

Create domains scim token

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create domains verify

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Community questions