Connectors

Get connector

Get connector data by ID

get/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.

Response

The connector data.

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.