XAxata
Organizations

Update an identity provider's credentials

Changed on

Replaces the provider's credentials, and for oidc re-discovers its endpoints from the issuer. The domain it serves and whether it is enforced are carried across unchanged, so rotating a client secret does not quietly turn enforcement off. A provider whose domain stopped being verified is refused until the domain verifies again.

put/organizations/{organizationID}/sso/providers/{providerAlias}

Request

  • Base URL
    https://api.xata.tech
  • Auth
    OAuth 2
    Implicit: https://auth.xata.io/realms/xata/protocol/openid-connect/auth
    Scopes: org:write

Request body

issuerstring uri

OIDC issuer URL. Required for oidc, and for microsoft where it names the Entra tenant; ignored for google.

client_idstring required

OAuth client ID the organization registered with the provider

client_secretstring required

OAuth client secret. Write-only: it is stored in Keycloak and is never returned by this API.

Response

Identity provider updated

aliasstring required

Stable identifier for this provider, used in its own endpoints.

type'google' | 'microsoft' | 'oidc' required

Which identity provider this is. google pins the login to a Google Workspace domain and microsoft to a single Entra tenant, taken from the issuer; oidc is the fallback for anything else that speaks OpenID Connect.

display_namestring required

Name members see for this provider when signing in.

domainstring required

The verified email domain this provider serves. Empty while the domain is not verified.

enforcedboolean required

Whether members on this domain are sent to this provider automatically, leaving no other way in. Registering a provider does not set this; it is enabled separately.

issuerstring uri

OIDC issuer URL, without the /.well-known suffix.

client_idstring required

OAuth client ID the organization registered with the provider.

Changes