Create SSO connector

POST /api/sso-connectors

OAuth2

Create an new SSO connector instance for a given provider.

application/json

Body Required

config object

arbitrary

Additional properties are allowed.
domains array[string]
branding object

Additional properties are allowed.
Hide branding attributes Show branding attributes object
- displayName string
- logo string
- darkLogo string
syncProfile boolean
providerName string Required

Minimum length is 1, maximum length is 128.
connectorName string Required

Minimum length is 1, maximum length is 128.

Responses

200 application/json

The created 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
  
  Minimum length is 1, maximum length is 128.
- connectorName string Required
  
  Minimum length is 1, maximum length is 128.
- config object Required
  
  arbitrary
  
  Additional properties are allowed.
- domains array[string] Required
- branding object Required
  
  Additional properties are allowed.
  
  Hide branding attributes Show branding attributes object
  
  displayName string
  
  logo string
  
  darkLogo string
- syncProfile boolean Required
- createdAt number Required
400

Bad Request
401

Unauthorized
403

Forbidden
409

Conflict
422

At lease one of the given input fields is invalid or IdP connection cannot be verified with the given config.

POST /api/sso-connectors

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

Request examples

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

Response examples (200)

{
  "tenantId": "string",
  "id": "string",
  "providerName": "string",
  "connectorName": "string",
  "config": {},
  "domains": [
    "string"
  ],
  "branding": {
    "displayName": "string",
    "logo": "string",
    "darkLogo": "string"
  },
  "syncProfile": true,
  "createdAt": 42.0
}