SSO connectors

Update SSO connector

Update an SSO connector by ID. This method performs a partial update.

patch/api/sso-connectors/{id}

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/sso-connectors/{id}
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

idstring required

The unique identifier of the sso connector.

Request body

configobject

arbitrary

domainsstring[]
syncProfileboolean
connectorNamestring
enableTokenStorageboolean

Response

The updated SSO connector.

tenantIdstring required
idstring required
providerName'OIDC' | 'SAML' | 'AzureAD' | 'GoogleWorkspace' | 'Okta' | 'AzureAdOidc' required
connectorNamestring required
configobject required

arbitrary

domainsstring[] required
syncProfileboolean required
enableTokenStorageboolean required
createdAtnumber required
namestring required
providerType'oidc' | 'saml' required
providerLogostring required
providerLogoDarkstring required
providerConfigobject

Changes

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