Sign in
Admin

List Oauth Providers

List all OAuth providers (admin only).

get/settings/oauth-providers/

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

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

No recorded changes to this operation across all 50 revisions of this API.