Logto API references

List SSO connectors

GET /api/sso-connectors

Get SSO connectors with pagination. 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.

Query parameters

page integer

Page number (starts from 1).

Minimum value is 1. Default value is 1.
page_size integer

Entries per page.

Minimum value is 1. Default value is 20.

Responses

• 200 application/json

A list of SSO connectors.
Hide response attributes Show response attributes object
- 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
- domains array[string] Required
- branding object Required
  
  Hide branding attributes Show branding attributes
  
  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
  
  Hide providerConfig attributes Show providerConfig attributes
  
  Additional properties
  
  key null
• 401

Unauthorized
• 403

Forbidden

GET /api/sso-connectors

curl \
 -X GET https://[tenant_id].logto.app/api/sso-connectors

Response examples (200)

[
  {
    "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": {
      "key": null
    }
  }
]