Connectors

Update connector

Update connector by ID with the given data. This methods performs a partial update.

patch/api/connectors/{id}

Request

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

Path parameters

idstring required

The unique identifier of the connector.

Request body

configobject

The connector config object that will be passed to the connector. The config object should be compatible with the connector factory.

syncProfileboolean

Whether to sync user profile from the identity provider to Logto at each sign-in. If false, the user profile will only be synced when the user is created.

enableTokenStorageboolean

Response

The updated connector.

idstring required
syncProfileboolean required
enableTokenStorageboolean required
configobject required

arbitrary

connectorIdstring required
targetstring required
nameobject required

Validator function

descriptionobject required

Validator function

logostring required
logoDarkstring nullable required
readmestring required
configTemplatestring
customDataobject
fromEmailstring
platform'Native' | 'Universal' | 'Web' nullable required
isStandardboolean
isTokenStorageSupportedboolean
type'Email' | 'Sms' | 'Social' required
isDemoboolean
extraInfoobject
usagenumber

Example response

{
  "formItems": [
    {
      "defaultValue": {},
      "showConditions": [
        {
          "expectValue": {}
        }
      ]
    }
  ]
}

Changes

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