Skip to main content

List Linked Identity Providers

POST 
https://$CUSTOM-DOMAIN/admin/v1/policies/login/idps/_search

Returns a list of identity providers that are linked in the login policy. This means, that they are configured for the instance and will be shown to the users. It affects all organizations, without custom login settings.

Request​

Body

required

    query

    object

    Object unspecific list filters like offset, limit and asc/desc.

    offset uint64
    limit int64

    Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

    asc boolean

    default is descending

Responses​

Identity providers of default login policy

Schema

    details

    object

    totalResult uint64
    processedSequence uint64
    viewTimestamp date-time

    the last time the view got updated

    result

    object[]

  • Array [

    • idpId string

    the id of the identity provider

    idpName string

    the name of the identity provider

    idpType authorization framework of the identity provider (string)

    Possible values: [IDP_TYPE_UNSPECIFIED, IDP_TYPE_OIDC, IDP_TYPE_JWT]

    Default value: IDP_TYPE_UNSPECIFIED

    the authorization framework of the identity provider

  • ]

curl -L 'https://$CUSTOM-DOMAIN/admin/v1/policies/login/idps/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  }
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
Body required
{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  }
}
ResponseClear

Click the Send API Request button above and see the response here!