Connectors

Create connector

Create a connector with the given data.

post/api/connectors

Request

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

Request body

configobject

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

connectorIdstring required

The connector factory ID for creating the connector.

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
idstring

The unique ID for the connector. If not provided, a random ID will be generated.

Response

The created 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.