List Linked Identity Providers

POST 
https://$CUSTOM-DOMAIN/management/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 organization and will be shown to the users. They will be shown if the organization is identified (per scope or user).

Request

Header Parameters

x-zitadel-orgid string

The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.

application/json

Bodyrequired

query object

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

offsetuint64

Example: 0

limitint64

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.

Example: 100

ascboolean

default is descending

application/grpc

Bodyrequired

query object

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

offsetuint64

Example: 0

limitint64

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.

Example: 100

ascboolean

default is descending

application/grpc-web+proto

Bodyrequired

query object

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

offsetuint64

Example: 0

limitint64

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.

Example: 100

ascboolean

default is descending

Responses

200

A successful response.

application/json

Schema

Schema

details object

totalResultuint64

Example: 2

processedSequenceuint64

Example: 267831

viewTimestampdate-time

the last time the view got updated

result object[]
Array [
idpIdstring
the id of the identity provider
Example: 69629023906488334
idpNamestring
the name of the identity provider
Example: google
idpTypeauthorization framework of the identity provider (string)
the authorization framework of the identity provider
Possible values: [IDP_TYPE_UNSPECIFIED, IDP_TYPE_OIDC, IDP_TYPE_JWT]
Default value: IDP_TYPE_UNSPECIFIED
Example: ["IDP_TYPE_OIDC"]
]

Example (auto)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-07-29T15:51:28.071Z"
  },
  "result": [
    {
      "idpId": "69629023906488334",
      "idpName": "google",
      "idpType": [
        "IDP_TYPE_OIDC"
      ]
    }
  ]
}

application/grpc

Schema

Schema

details object

totalResultuint64

Example: 2

processedSequenceuint64

Example: 267831

viewTimestampdate-time

the last time the view got updated

result object[]
Array [
idpIdstring
the id of the identity provider
Example: 69629023906488334
idpNamestring
the name of the identity provider
Example: google
idpTypeauthorization framework of the identity provider (string)
the authorization framework of the identity provider
Possible values: [IDP_TYPE_UNSPECIFIED, IDP_TYPE_OIDC, IDP_TYPE_JWT]
Default value: IDP_TYPE_UNSPECIFIED
Example: ["IDP_TYPE_OIDC"]
]

Example (auto)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-07-29T15:51:28.071Z"
  },
  "result": [
    {
      "idpId": "69629023906488334",
      "idpName": "google",
      "idpType": [
        "IDP_TYPE_OIDC"
      ]
    }
  ]
}

application/grpc-web+proto

Schema

Schema

details object

totalResultuint64

Example: 2

processedSequenceuint64

Example: 267831

viewTimestampdate-time

the last time the view got updated

result object[]
Array [
idpIdstring
the id of the identity provider
Example: 69629023906488334
idpNamestring
the name of the identity provider
Example: google
idpTypeauthorization framework of the identity provider (string)
the authorization framework of the identity provider
Possible values: [IDP_TYPE_UNSPECIFIED, IDP_TYPE_OIDC, IDP_TYPE_JWT]
Default value: IDP_TYPE_UNSPECIFIED
Example: ["IDP_TYPE_OIDC"]
]

Example (auto)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-07-29T15:51:28.071Z"
  },
  "result": [
    {
      "idpId": "69629023906488334",
      "idpName": "google",
      "idpType": [
        "IDP_TYPE_OIDC"
      ]
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Authorization: oauth2

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN/management/v1

Auth

Bearer Token

Parameters

x-zitadel-orgid — header

Body required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  }
}

ResponseClear

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