SSO Providers (Self Hosted Only)

List registered SSO providers

get

Self-hosted only. Returns all registered SAML SSO providers and their associated domains.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

403

Forbidden - Requires role: owner

No content

get

/sfp/api/sso/providers

HTTPcURLJavaScriptPython

GET /sfp/api/sso/providers HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

403

Forbidden - Requires role: owner

No content

Register a SAML SSO provider

post

Self-hosted only. Registers a SAML identity provider (Azure AD, Okta, etc.) for SSO authentication. Requires owner role.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

metadataUrlstringRequired

SAML metadata URL from your IdP

Example: https://login.microsoftonline.com/.../federationmetadata.xml

domainsstring[]Required

Email domains for this SSO provider

Example: ["company.com"]

providerIdstringOptional

Provider ID from a pre-registered IdP (cloud mode). When set, skips GoTrue registration and stores this ID directly for config auto-detect.

Example: f7cac9b2-dee0-4e73-b2fd-45116284175e

Responses

201

SSO provider registered

403

Forbidden - Requires role: owner

No content

post

/sfp/api/sso/providers

HTTPcURLJavaScriptPython

POST /sfp/api/sso/providers HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 156

{
  "metadataUrl": "https://login.microsoftonline.com/.../federationmetadata.xml",
  "domains": [
    "company.com"
  ],
  "providerId": "f7cac9b2-dee0-4e73-b2fd-45116284175e"
}

No content

Remove an SSO provider

delete

Self-hosted only. Removes a SAML SSO provider by ID.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

403

Forbidden - Requires role: owner

No content

delete

/sfp/api/sso/providers/{id}

HTTPcURLJavaScriptPython

DELETE /sfp/api/sso/providers/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

403

Forbidden - Requires role: owner

No content