Get the current active identity providers

Return the current active identity providers for the requested context

Query Parameters

ctx.orgId string
ctx.instance boolean

Responses

• 200
• 403
• 404
• default

---

OK

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

details object

totalResult uint64

processedSequence uint64

timestamp date-time

the last time the projection got updated

identityProviders object[]
Array [
id string
name string
type string
Possible values: [IDENTITY_PROVIDER_TYPE_UNSPECIFIED, IDENTITY_PROVIDER_TYPE_OIDC, IDENTITY_PROVIDER_TYPE_JWT, IDENTITY_PROVIDER_TYPE_LDAP, IDENTITY_PROVIDER_TYPE_OAUTH, IDENTITY_PROVIDER_TYPE_AZURE_AD, IDENTITY_PROVIDER_TYPE_GITHUB, IDENTITY_PROVIDER_TYPE_GITHUB_ES, IDENTITY_PROVIDER_TYPE_GITLAB, IDENTITY_PROVIDER_TYPE_GITLAB_SELF_HOSTED, IDENTITY_PROVIDER_TYPE_GOOGLE]
Default value: IDENTITY_PROVIDER_TYPE_UNSPECIFIED
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "timestamp": "2024-06-17T11:37:09.476Z"
  },
  "identityProviders": [
    {
      "id": "string",
      "name": "string",
      "type": "IDENTITY_PROVIDER_TYPE_UNSPECIFIED"
    }
  ]
}

Schema

Example (from schema)

---

Schema

details object

totalResult uint64

processedSequence uint64

timestamp date-time

the last time the projection got updated

identityProviders object[]
Array [
id string
name string
type string
Possible values: [IDENTITY_PROVIDER_TYPE_UNSPECIFIED, IDENTITY_PROVIDER_TYPE_OIDC, IDENTITY_PROVIDER_TYPE_JWT, IDENTITY_PROVIDER_TYPE_LDAP, IDENTITY_PROVIDER_TYPE_OAUTH, IDENTITY_PROVIDER_TYPE_AZURE_AD, IDENTITY_PROVIDER_TYPE_GITHUB, IDENTITY_PROVIDER_TYPE_GITHUB_ES, IDENTITY_PROVIDER_TYPE_GITLAB, IDENTITY_PROVIDER_TYPE_GITLAB_SELF_HOSTED, IDENTITY_PROVIDER_TYPE_GOOGLE]
Default value: IDENTITY_PROVIDER_TYPE_UNSPECIFIED
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "timestamp": "2024-06-17T11:37:09.478Z"
  },
  "identityProviders": [
    {
      "id": "string",
      "name": "string",
      "type": "IDENTITY_PROVIDER_TYPE_UNSPECIFIED"
    }
  ]
}

Schema

Example (from schema)

---

Schema

details object

totalResult uint64

processedSequence uint64

timestamp date-time

the last time the projection got updated

identityProviders object[]
Array [
id string
name string
type string
Possible values: [IDENTITY_PROVIDER_TYPE_UNSPECIFIED, IDENTITY_PROVIDER_TYPE_OIDC, IDENTITY_PROVIDER_TYPE_JWT, IDENTITY_PROVIDER_TYPE_LDAP, IDENTITY_PROVIDER_TYPE_OAUTH, IDENTITY_PROVIDER_TYPE_AZURE_AD, IDENTITY_PROVIDER_TYPE_GITHUB, IDENTITY_PROVIDER_TYPE_GITHUB_ES, IDENTITY_PROVIDER_TYPE_GITLAB, IDENTITY_PROVIDER_TYPE_GITLAB_SELF_HOSTED, IDENTITY_PROVIDER_TYPE_GOOGLE]
Default value: IDENTITY_PROVIDER_TYPE_UNSPECIFIED
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "timestamp": "2024-06-17T11:37:09.478Z"
  },
  "identityProviders": [
    {
      "id": "string",
      "name": "string",
      "type": "IDENTITY_PROVIDER_TYPE_UNSPECIFIED"
    }
  ]
}

Returned when the user does not have permission to access the resource.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Returned when the resource does not exist.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

GET /v2beta/settings/login/idps

Authorization

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"
    }
  }
}

Request

Base URL

https://$CUSTOM-DOMAIN

Bearer Token

ctx.orgId — query

ctx.instance — query

---truefalse

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X GET 'https://$CUSTOM-DOMAIN/v2beta/settings/login/idps' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

python / requests

curl -L -X GET 'https://$CUSTOM-DOMAIN/v2beta/settings/login/idps' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

go / native

curl -L -X GET 'https://$CUSTOM-DOMAIN/v2beta/settings/login/idps' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

nodejs / axios

curl -L -X GET 'https://$CUSTOM-DOMAIN/v2beta/settings/login/idps' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

ruby / Net::HTTP

curl -L -X GET 'https://$CUSTOM-DOMAIN/v2beta/settings/login/idps' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

csharp / RestSharp

curl -L -X GET 'https://$CUSTOM-DOMAIN/v2beta/settings/login/idps' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

php / cURL

curl -L -X GET 'https://$CUSTOM-DOMAIN/v2beta/settings/login/idps' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

java / OkHttp

curl -L -X GET 'https://$CUSTOM-DOMAIN/v2beta/settings/login/idps' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

powershell / RestMethod

curl -L -X GET 'https://$CUSTOM-DOMAIN/v2beta/settings/login/idps' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'