List Linked Identity Providers
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.
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
query object
Object unspecific list filters like offset, limit and asc/desc.
offset uint64limit int64Maximum 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 booleandefault is descending
Request Body required
query object
Object unspecific list filters like offset, limit and asc/desc.
offset uint64limit int64Maximum 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 booleandefault is descending
Request Body required
query object
Object unspecific list filters like offset, limit and asc/desc.
offset uint64limit int64Maximum 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 booleandefault is descending
- 200
- 403
- 404
- default
Identity providers of default login policy
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
totalResult uint64processedSequence uint64viewTimestamp date-timethe last time the view got updated
result object[]
Array [idpId stringthe id of the identity provider
idpName stringthe name of the identity provider
idpType authorization framework of the identity providerPossible values: [
IDP_TYPE_UNSPECIFIED
,IDP_TYPE_OIDC
,IDP_TYPE_JWT
]Default value:
IDP_TYPE_UNSPECIFIED
the authorization framework of the identity provider
]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-12"
},
"result": [
{
"idpId": "69629023906488334",
"idpName": "google",
"idpType": [
"IDP_TYPE_OIDC"
]
}
]
}
- Schema
- Example (from schema)
Schema
details object
totalResult uint64processedSequence uint64viewTimestamp date-timethe last time the view got updated
result object[]
Array [idpId stringthe id of the identity provider
idpName stringthe name of the identity provider
idpType authorization framework of the identity providerPossible values: [
IDP_TYPE_UNSPECIFIED
,IDP_TYPE_OIDC
,IDP_TYPE_JWT
]Default value:
IDP_TYPE_UNSPECIFIED
the authorization framework of the identity provider
]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-12"
},
"result": [
{
"idpId": "69629023906488334",
"idpName": "google",
"idpType": [
"IDP_TYPE_OIDC"
]
}
]
}
- Schema
- Example (from schema)
Schema
details object
totalResult uint64processedSequence uint64viewTimestamp date-timethe last time the view got updated
result object[]
Array [idpId stringthe id of the identity provider
idpName stringthe name of the identity provider
idpType authorization framework of the identity providerPossible values: [
IDP_TYPE_UNSPECIFIED
,IDP_TYPE_OIDC
,IDP_TYPE_JWT
]Default value:
IDP_TYPE_UNSPECIFIED
the authorization framework of the identity provider
]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-12"
},
"result": [
{
"idpId": "69629023906488334",
"idpName": "google",
"idpType": [
"IDP_TYPE_OIDC"
]
}
]
}
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"
}
]
}