Workspace SSO

Add an SSO provider to a workspace

post/workspaces/{workspace_id}/sso-providers

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/workspaces/{workspace_id}/sso-providers
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Path parameters

workspace_idstring required

Request body

email_domainstring required

Email domain this SSO provider applies to

provider_idstring

Identity provider id used for SSO validation

keycloak_idp_aliasstring

Keycloak identity provider alias used for kc_idp_hint routing

Example request

{
  "email_domain": "axon.com",
  "provider_id": "oidc.axon",
  "keycloak_idp_alias": "axon"
}

Response

idstring required

SSO provider id

email_domainstring required
provider_idstring nullable
keycloak_idp_aliasstring nullable

Example response

{
  "email_domain": "axon.com",
  "provider_id": "oidc.axon",
  "keycloak_idp_alias": "axon"
}

Changes

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