v1

latestOpenAPI 3.0.0Apache 2.02026-07-26322141.0 KB

API Gateway

Update Auth Provider

Update an existing SSO auth provider (super admin only, database providers only)

put/v2/orgs/{orgSlug}/auth/sso/{slug}

Path parameters

orgSlugstring required

Organization slug

slugstring required

Provider slug

Request body

idstring

slugstring required

Unique provider identifier (e.g. "google", "okta-saml")

namestring

Display name for the provider (e.g. "Google", "Corporate SSO")

iconstring

Icon URL or identifier for the provider

type'oidc' | 'saml' required

source'file' | 'database'

Where this provider is configured (read-only, returned by GET)

enabledboolean

Whether this provider is active (default true). Disabled providers are not registered as passport strategies.

metaobject

Free-form metadata JSON

domainsstring[]

Associated domain names

orgSlugstring

Associated organization slug

Response

Success Response

idstring

slugstring required

Unique provider identifier (e.g. "google", "okta-saml")

namestring

Display name for the provider (e.g. "Google", "Corporate SSO")

iconstring

Icon URL or identifier for the provider

type'oidc' | 'saml' required

source'file' | 'database'

Where this provider is configured (read-only, returned by GET)

enabledboolean

Whether this provider is active (default true). Disabled providers are not registered as passport strategies.

metaobject

Free-form metadata JSON

domainsstring[]

Associated domain names

orgSlugstring

Associated organization slug