Sign in
Admin

Update Oauth Provider

Changed on

Update an existing OAuth or SAML provider (admin only).

Audit-log payload contains details.changes with per-field {"old": ..., "new": ...} diffs. Secret fields (idp_certificate, client_secret_encrypted, client_secret) are redacted as {"old": "<redacted>", "new": "<redacted>"}.

put/settings/oauth-providers/{provider_id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

provider_idstring uuid required

Request body

slugstring nullable

New slug. Changes the callback URL — coordinate with the IdP before updating.

display_namestring nullable

New display label.

provider_type'google' | 'microsoft' | 'oidc' | 'saml' | 'github' nullable

New provider type. Rarely changed after creation.

client_idstring nullable

New client ID. Set when rotating credentials.

client_secretstring nullable

New client secret. Omit to leave unchanged; setting this rotates the stored secret.

discovery_urlstring nullable

Updated OIDC discovery URL.

authorize_urlstring nullable

Updated authorization endpoint.

token_urlstring nullable

Updated token endpoint.

userinfo_urlstring nullable

Updated userinfo endpoint.

idp_entity_idstring nullable

Updated SAML IdP entityID.

idp_sso_urlstring nullable

Updated SAML IdP SSO URL.

idp_certificatestring nullable

Updated SAML IdP signing certificate (PEM). Setting this rotates the stored cert; omit to leave unchanged.

sp_entity_idstring nullable

Updated SP entityID.

scopesstring nullable

Updated space-separated scopes.

default_rolestring nullable

Updated default role for new users: 'viewer', 'editor', or 'admin'.

group_claimstring nullable

Updated group claim name.

group_role_mappingobject nullable

Updated group-to-role mapping, with the same rules as on create. Pass an empty object to clear.

enabledboolean nullable

Set to false to hide the provider button without deleting the configuration.

Response

Successful Response

idstring uuid required

Unique provider identifier.

slugstring required

URL-safe identifier used in the callback URL.

display_namestring required

Label shown on the login page button.

provider_typestring required

Provider type: 'google', 'microsoft', 'oidc', or 'saml'.

client_idstring nullable

OAuth client ID. Visible to admins; never exposes client_secret. Null for SAML providers.

discovery_urlstring nullable

OIDC discovery URL.

authorize_urlstring nullable

Authorization endpoint.

token_urlstring nullable

Token endpoint.

userinfo_urlstring nullable

Userinfo endpoint.

idp_entity_idstring nullable

SAML IdP entityID (SAML providers only).

idp_sso_urlstring nullable

SAML IdP SSO URL (SAML providers only).

sp_entity_idstring nullable

SP entityID for this SAML provider (SAML providers only).

scopesstring required

Space-separated OAuth scopes.

default_rolestring required

Default role assigned to new users.

group_claimstring nullable

Claim name used for group-based role mapping.

group_role_mappingobject nullable

Group-to-role mapping rules.

enabledboolean required

Whether the provider button appears on the login page.

created_atstring date-time required

Timestamp the provider was created.

updated_atstring date-time required

Timestamp the provider was last updated.

Changes