Get SSO connector

GET /api/sso-connectors/{id}

Get SSO connector data by ID. In addition to the raw SSO connector data, a copy of fetched or parsed IdP configs and a copy of connector provider's data will be attached.

Path parameters

id string Required

The unique identifier of the sso connector.

Responses

200 application/json

The SSO connector data with the given ID.
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
  
  Values are OIDC, SAML, AzureAD, GoogleWorkspace, Okta, or AzureAdOidc.
- 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
- name string Required
- providerType string Required
  
  Values are oidc or saml.
- providerLogo string Required
- providerLogoDark string Required
- providerConfig object
400

Bad Request
401

Unauthorized
403

Forbidden
404

SSO connector not found.

GET /api/sso-connectors/{id}

curl \
 -X GET https://[tenant_id].logto.app/api/sso-connectors/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "tenantId": "string",
  "id": "string",
  "providerName": "OIDC",
  "connectorName": "string",
  "config": {},
  "domains": [
    "string"
  ],
  "branding": {
    "displayName": "string",
    "logo": "string",
    "darkLogo": "string"
  },
  "syncProfile": true,
  "createdAt": 42.0,
  "name": "string",
  "providerType": "oidc",
  "providerLogo": "string",
  "providerLogoDark": "string",
  "providerConfig": {}
}