ZITADEL Docs
APIsCore ResourcesV1Instance Objects

ListProviders

Returns all identity providers, which match the query Limit should always be set, there is a default limit set by the service

POST
/idps/templates/_search

Request Body

application/json

query?

list limitations and ordering

queries?

criteria the client is looking for

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/idps/templates/_search" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "totalResult": 0,
    "processedSequence": 0,
    "viewTimestamp": "1s"
  },
  "result": [
    {
      "id": "string",
      "details": {
        "sequence": 0,
        "creationDate": "1s",
        "changeDate": "1s",
        "resourceOwner": "string"
      },
      "state": "IDP_STATE_UNSPECIFIED",
      "name": "string",
      "owner": "IDP_OWNER_TYPE_UNSPECIFIED",
      "type": "PROVIDER_TYPE_UNSPECIFIED",
      "config": {
        "options": {
          "isLinkingAllowed": true,
          "isCreationAllowed": true,
          "isAutoCreation": true,
          "isAutoUpdate": true,
          "autoLinking": "AUTO_LINKING_OPTION_UNSPECIFIED"
        },
        "apple": {
          "clientId": "string",
          "teamId": "string",
          "keyId": "string",
          "scopes": [
            "string"
          ]
        }
      }
    }
  ]
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?