Update SSO connector

PATCH /api/sso-connectors/{id}

OAuth2

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

Path parameters

id string Required

The unique identifier of the sso connector.

application/json

Body Required

config object

arbitrary
domains array[string]
branding object
Hide branding attributes Show branding attributes object
- displayName string
- logo string
- darkLogo string
syncProfile boolean
connectorName string

Minimum length is 1, maximum length is 128.

Responses

200 application/json

The updated SSO connector.
Hide response attributes Show response attributes object
- tenantId string Required
  
  Maximum length is 21.
- id string Required
  
  Minimum length is 1, maximum length is 128.
- providerName string Required
  
  Values are OIDC, SAML, AzureAD, GoogleWorkspace, Okta, or AzureAdOidc.
- connectorName string Required
  
  Minimum length is 1, maximum length is 128.
- config object Required
  
  arbitrary
- domains array[string] Required
- branding object Required
  
  Hide branding attributes Show branding attributes object
  
  displayName string
  
  logo string
  
  darkLogo string
- syncProfile boolean Required
- createdAt number Required
- name string Required
- providerType string Required
  
  Values are oidc or saml.
- providerLogo string Required
- providerLogoDark string Required
- providerConfig object
400

Bad Request
401

Unauthorized
403

Forbidden
404

SSO connector not found.
409

Conflict
422

At lease one of the update fields is invalid or IdP connection can not be verified with the given connection config.

PATCH /api/sso-connectors/{id}

curl \
 -X PATCH https://[tenant_id].logto.app/api/sso-connectors/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"config":{},"domains":["string"],"branding":{"displayName":"string","logo":"string","darkLogo":"string"},"syncProfile":true,"connectorName":"string"}'

Request examples

{
  "config": {},
  "domains": [
    "string"
  ],
  "branding": {
    "displayName": "string",
    "logo": "string",
    "darkLogo": "string"
  },
  "syncProfile": true,
  "connectorName": "string"
}

Response examples (200)

{
  "tenantId": "string",
  "id": "string",
  "providerName": "OIDC",
  "connectorName": "string",
  "config": {},
  "domains": [
    "string"
  ],
  "branding": {
    "displayName": "string",
    "logo": "string",
    "darkLogo": "string"
  },
  "syncProfile": true,
  "createdAt": 42.0,
  "name": "string",
  "providerType": "oidc",
  "providerLogo": "string",
  "providerLogoDark": "string",
  "providerConfig": {}
}