Update connector

PATCH /api/connectors/{id}

OAuth2

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

Path parameters

id string Required

The unique identifier of the connector.

application/json

Body Required

config object

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

Additional properties are allowed.
metadata object

Custom connector metadata, will be used to overwrite the default connector metadata.

Additional properties are allowed.
Hide metadata attributes Show metadata attributes object
- target string
- name object
  
  Validator function
  
  Additional properties are allowed.
- logo string
- logoDark string | null
syncProfile boolean

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.

Responses

200 application/json

The updated connector.
Hide response attributes Show response attributes object
- id string Required
- syncProfile boolean Required
- config object Required
  
  arbitrary
  
  Additional properties are allowed.
- metadata object Required
  
  Additional properties are allowed.
  
  Hide metadata attributes Show metadata attributes object
  
  target string
  
  name object
  
  Validator function
  
  Additional properties are allowed.
  
  logo string
  
  logoDark string | null
- connectorId string Required
  
  Minimum length is 1, maximum length is 128.
- target string Required
- name object Required
  
  Validator function
  
  Additional properties are allowed.
- description object Required
  
  Validator function
  
  Additional properties are allowed.
- logo string Required
- logoDark string | null Required
- readme string Required
- configTemplate string
- formItems array[object]
  
  One of:
  object-1 object object-2 object object-3 object
  
  Hide attributes Show attributes
  
  type string("Select") Required
  
  selectItems array[object] Required
  
  Hide selectItems attributes Show selectItems attributes object
  
  value string Required
  
  title string Required
  
  key string Required
  
  label string Required
  
  placeholder string
  
  required boolean
  
  defaultValue
  
  showConditions array[object]
  
  Hide showConditions attributes Show showConditions attributes object
  
  targetKey string Required
  
  expectValue
  
  description string
  
  tooltip string
  
  isConfidential boolean
  
  Hide attributes Show attributes
  
  type string("MultiSelect") Required
  
  selectItems array[object] Required
  
  Hide selectItems attribute Show selectItems attribute object
  
  value string Required
  
  key string Required
  
  label string Required
  
  placeholder string
  
  required boolean
  
  defaultValue
  
  showConditions array[object]
  
  Hide showConditions attributes Show showConditions attributes object
  
  targetKey string Required
  
  expectValue
  
  description string
  
  tooltip string
  
  isConfidential boolean
  
  Hide attributes Show attributes
  
  type string Required
  
  Values are Text, Number, MultilineText, Switch, or Json.
  
  key string Required
  
  label string Required
  
  placeholder string
  
  required boolean
  
  defaultValue
  
  showConditions array[object]
  
  Hide showConditions attributes Show showConditions attributes object
  
  targetKey string Required
  
  expectValue
  
  description string
  
  tooltip string
  
  isConfidential boolean
- customData object
- fromEmail string
- platform string | null Required
  
  Values are Native, Universal, or Web.
- isStandard boolean
- type string Required
  
  Values are Email, Sms, or Social.
- isDemo boolean
- extraInfo object
- usage number
400

Invalid request body.
401

Unauthorized
403

Forbidden
404

Connector not found.
422

Patch operation triggered a connector conflict.

PATCH /api/connectors/{id}

curl \
 -X PATCH https://[tenant_id].logto.app/api/connectors/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"config":{},"metadata":{"target":"string","name":{},"logo":"string","logoDark":"string"},"syncProfile":true}'

Request examples

{
  "config": {},
  "metadata": {
    "target": "string",
    "name": {},
    "logo": "string",
    "logoDark": "string"
  },
  "syncProfile": true
}

Response examples (200)

{
  "id": "string",
  "syncProfile": true,
  "config": {},
  "metadata": {
    "target": "string",
    "name": {},
    "logo": "string",
    "logoDark": "string"
  },
  "connectorId": "string",
  "target": "string",
  "name": {},
  "description": {},
  "logo": "string",
  "logoDark": "string",
  "readme": "string",
  "configTemplate": "string",
  "formItems": [
    {
      "type": "string",
      "selectItems": [
        {
          "value": "string",
          "title": "string"
        }
      ],
      "key": "string",
      "label": "string",
      "placeholder": "string",
      "required": true,
      "showConditions": [
        {
          "targetKey": "string"
        }
      ],
      "description": "string",
      "tooltip": "string",
      "isConfidential": true
    }
  ],
  "customData": {},
  "fromEmail": "string",
  "platform": "Native",
  "isStandard": true,
  "type": "Email",
  "isDemo": true,
  "extraInfo": {},
  "usage": 42.0
}