ZITADEL Docs
APIsCore ResourcesV2Identity Provider

GetIDPByID

Get identity provider (IdP) by ID

Returns an identity provider (social/enterprise login) by its ID, which can be of the type Google, AzureAD, etc.

GET
/v2/idps/{id}

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://loading/v2/idps/string"
{
  "idp": {
    "id": "string",
    "details": {
      "sequence": 0,
      "changeDate": "1s",
      "resourceOwner": "string",
      "creationDate": "1s"
    },
    "state": "IDP_STATE_UNSPECIFIED",
    "name": "string",
    "type": "IDP_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?