Deprecated: Search Identity Providers (IDP)​
This endpoint has been deprecated and may be removed in future versions of the API.
Returns a list of identity providers (social/enterprise login) configured on an instance level. e.g Google, AzureAD, etc.
Request Body required
- Array [
- ]
query object
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
Possible values: [IDP_FIELD_NAME_UNSPECIFIED
, IDP_FIELD_NAME_NAME
]
Default value: IDP_FIELD_NAME_UNSPECIFIED
queries object[]
idpIdQuery object
idpNameQuery object
Possible values: [TEXT_QUERY_METHOD_EQUALS
, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE
, TEXT_QUERY_METHOD_STARTS_WITH
, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE
, TEXT_QUERY_METHOD_CONTAINS
, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE
, TEXT_QUERY_METHOD_ENDS_WITH
, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE
]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
Request Body required
- Array [
- ]
query object
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
Possible values: [IDP_FIELD_NAME_UNSPECIFIED
, IDP_FIELD_NAME_NAME
]
Default value: IDP_FIELD_NAME_UNSPECIFIED
queries object[]
idpIdQuery object
idpNameQuery object
Possible values: [TEXT_QUERY_METHOD_EQUALS
, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE
, TEXT_QUERY_METHOD_STARTS_WITH
, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE
, TEXT_QUERY_METHOD_CONTAINS
, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE
, TEXT_QUERY_METHOD_ENDS_WITH
, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE
]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
Request Body required
- Array [
- ]
query object
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
Possible values: [IDP_FIELD_NAME_UNSPECIFIED
, IDP_FIELD_NAME_NAME
]
Default value: IDP_FIELD_NAME_UNSPECIFIED
queries object[]
idpIdQuery object
idpNameQuery object
Possible values: [TEXT_QUERY_METHOD_EQUALS
, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE
, TEXT_QUERY_METHOD_STARTS_WITH
, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE
, TEXT_QUERY_METHOD_CONTAINS
, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE
, TEXT_QUERY_METHOD_ENDS_WITH
, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE
]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
- 200
- 400
- 403
- 404
- default
idps found
Schema
- Array [
- ]
details object
the last time the view got updated
Possible values: [IDP_FIELD_NAME_UNSPECIFIED
, IDP_FIELD_NAME_NAME
]
Default value: IDP_FIELD_NAME_UNSPECIFIED
result object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [IDP_STATE_UNSPECIFIED
, IDP_STATE_ACTIVE
, IDP_STATE_INACTIVE
]
Default value: IDP_STATE_UNSPECIFIED
the state of the identity provider
Possible values: [STYLING_TYPE_UNSPECIFIED
, STYLING_TYPE_GOOGLE
]
Default value: STYLING_TYPE_UNSPECIFIED
some identity providers specify the styling of the button to their login
Possible values: [IDP_OWNER_TYPE_UNSPECIFIED
, IDP_OWNER_TYPE_SYSTEM
, IDP_OWNER_TYPE_ORG
]
Default value: IDP_OWNER_TYPE_UNSPECIFIED
the administrator of this identity provider
oidcConfig object
client id generated by the identity provider
the OIDC issuer of the identity provider
the scopes requested by ZITADEL during the request on the identity provider
Possible values: [OIDC_MAPPING_FIELD_UNSPECIFIED
, OIDC_MAPPING_FIELD_PREFERRED_USERNAME
, OIDC_MAPPING_FIELD_EMAIL
]
Default value: OIDC_MAPPING_FIELD_UNSPECIFIED
definition which field is mapped to the display name of the user
Possible values: [OIDC_MAPPING_FIELD_UNSPECIFIED
, OIDC_MAPPING_FIELD_PREFERRED_USERNAME
, OIDC_MAPPING_FIELD_EMAIL
]
Default value: OIDC_MAPPING_FIELD_UNSPECIFIED
definition which field is mapped to the email of the user
jwtConfig object
the endpoint where the JWT can be extracted
the issuer of the JWT (for validation)
the endpoint to the key (JWK) which is used to sign the JWT with
the name of the header where the JWT is sent in, default is authorization
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:38.903Z"
},
"sortingColumn": "IDP_FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.903Z",
"changeDate": "2024-06-13T06:44:38.903Z",
"resourceOwner": "69629023906488334"
},
"state": "IDP_STATE_UNSPECIFIED",
"name": "google",
"stylingType": "STYLING_TYPE_UNSPECIFIED",
"owner": "IDP_OWNER_TYPE_UNSPECIFIED",
"oidcConfig": {
"clientId": "string",
"issuer": "https://accounts.google.com",
"scopes": [
"openid",
"profile",
"email"
],
"displayNameMapping": "OIDC_MAPPING_FIELD_UNSPECIFIED",
"usernameMapping": "OIDC_MAPPING_FIELD_UNSPECIFIED"
},
"jwtConfig": {
"jwtEndpoint": "https://accounts.google.com",
"issuer": "https://accounts.google.com",
"keysEndpoint": "https://accounts.google.com/keys",
"headerName": "x-auth-token"
},
"autoRegister": true
}
]
}
Schema
- Array [
- ]
details object
the last time the view got updated
Possible values: [IDP_FIELD_NAME_UNSPECIFIED
, IDP_FIELD_NAME_NAME
]
Default value: IDP_FIELD_NAME_UNSPECIFIED
result object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [IDP_STATE_UNSPECIFIED
, IDP_STATE_ACTIVE
, IDP_STATE_INACTIVE
]
Default value: IDP_STATE_UNSPECIFIED
the state of the identity provider
Possible values: [STYLING_TYPE_UNSPECIFIED
, STYLING_TYPE_GOOGLE
]
Default value: STYLING_TYPE_UNSPECIFIED
some identity providers specify the styling of the button to their login
Possible values: [IDP_OWNER_TYPE_UNSPECIFIED
, IDP_OWNER_TYPE_SYSTEM
, IDP_OWNER_TYPE_ORG
]
Default value: IDP_OWNER_TYPE_UNSPECIFIED
the administrator of this identity provider
oidcConfig object
client id generated by the identity provider
the OIDC issuer of the identity provider
the scopes requested by ZITADEL during the request on the identity provider
Possible values: [OIDC_MAPPING_FIELD_UNSPECIFIED
, OIDC_MAPPING_FIELD_PREFERRED_USERNAME
, OIDC_MAPPING_FIELD_EMAIL
]
Default value: OIDC_MAPPING_FIELD_UNSPECIFIED
definition which field is mapped to the display name of the user
Possible values: [OIDC_MAPPING_FIELD_UNSPECIFIED
, OIDC_MAPPING_FIELD_PREFERRED_USERNAME
, OIDC_MAPPING_FIELD_EMAIL
]
Default value: OIDC_MAPPING_FIELD_UNSPECIFIED
definition which field is mapped to the email of the user
jwtConfig object
the endpoint where the JWT can be extracted
the issuer of the JWT (for validation)
the endpoint to the key (JWK) which is used to sign the JWT with
the name of the header where the JWT is sent in, default is authorization
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:38.903Z"
},
"sortingColumn": "IDP_FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.904Z",
"changeDate": "2024-06-13T06:44:38.904Z",
"resourceOwner": "69629023906488334"
},
"state": "IDP_STATE_UNSPECIFIED",
"name": "google",
"stylingType": "STYLING_TYPE_UNSPECIFIED",
"owner": "IDP_OWNER_TYPE_UNSPECIFIED",
"oidcConfig": {
"clientId": "string",
"issuer": "https://accounts.google.com",
"scopes": [
"openid",
"profile",
"email"
],
"displayNameMapping": "OIDC_MAPPING_FIELD_UNSPECIFIED",
"usernameMapping": "OIDC_MAPPING_FIELD_UNSPECIFIED"
},
"jwtConfig": {
"jwtEndpoint": "https://accounts.google.com",
"issuer": "https://accounts.google.com",
"keysEndpoint": "https://accounts.google.com/keys",
"headerName": "x-auth-token"
},
"autoRegister": true
}
]
}
Schema
- Array [
- ]
details object
the last time the view got updated
Possible values: [IDP_FIELD_NAME_UNSPECIFIED
, IDP_FIELD_NAME_NAME
]
Default value: IDP_FIELD_NAME_UNSPECIFIED
result object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [IDP_STATE_UNSPECIFIED
, IDP_STATE_ACTIVE
, IDP_STATE_INACTIVE
]
Default value: IDP_STATE_UNSPECIFIED
the state of the identity provider
Possible values: [STYLING_TYPE_UNSPECIFIED
, STYLING_TYPE_GOOGLE
]
Default value: STYLING_TYPE_UNSPECIFIED
some identity providers specify the styling of the button to their login
Possible values: [IDP_OWNER_TYPE_UNSPECIFIED
, IDP_OWNER_TYPE_SYSTEM
, IDP_OWNER_TYPE_ORG
]
Default value: IDP_OWNER_TYPE_UNSPECIFIED
the administrator of this identity provider
oidcConfig object
client id generated by the identity provider
the OIDC issuer of the identity provider
the scopes requested by ZITADEL during the request on the identity provider
Possible values: [OIDC_MAPPING_FIELD_UNSPECIFIED
, OIDC_MAPPING_FIELD_PREFERRED_USERNAME
, OIDC_MAPPING_FIELD_EMAIL
]
Default value: OIDC_MAPPING_FIELD_UNSPECIFIED
definition which field is mapped to the display name of the user
Possible values: [OIDC_MAPPING_FIELD_UNSPECIFIED
, OIDC_MAPPING_FIELD_PREFERRED_USERNAME
, OIDC_MAPPING_FIELD_EMAIL
]
Default value: OIDC_MAPPING_FIELD_UNSPECIFIED
definition which field is mapped to the email of the user
jwtConfig object
the endpoint where the JWT can be extracted
the issuer of the JWT (for validation)
the endpoint to the key (JWK) which is used to sign the JWT with
the name of the header where the JWT is sent in, default is authorization
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:38.904Z"
},
"sortingColumn": "IDP_FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.904Z",
"changeDate": "2024-06-13T06:44:38.904Z",
"resourceOwner": "69629023906488334"
},
"state": "IDP_STATE_UNSPECIFIED",
"name": "google",
"stylingType": "STYLING_TYPE_UNSPECIFIED",
"owner": "IDP_OWNER_TYPE_UNSPECIFIED",
"oidcConfig": {
"clientId": "string",
"issuer": "https://accounts.google.com",
"scopes": [
"openid",
"profile",
"email"
],
"displayNameMapping": "OIDC_MAPPING_FIELD_UNSPECIFIED",
"usernameMapping": "OIDC_MAPPING_FIELD_UNSPECIFIED"
},
"jwtConfig": {
"jwtEndpoint": "https://accounts.google.com",
"issuer": "https://accounts.google.com",
"keysEndpoint": "https://accounts.google.com/keys",
"headerName": "x-auth-token"
},
"autoRegister": true
}
]
}
invalid query
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}