Deprecated: Add JWT Identity Provider (IDP)
This endpoint has been deprecated and may be removed in future versions of the API.
Create a new identity provider configuration on the organization to enable your users to log in with social/enterprise login. JSON Web Token Identity Provider (JWT IDP) gives you the possibility to use an (existing) JWT as a federated identity. You have to provide an endpoint where ZITADEL can get the existing JWT token.
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
- application/grpc
- application/grpc-web+proto
Request Body required
- name string required
Possible values:
non-empty
and<= 200 characters
- stylingType string
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
- jwtEndpoint string required
Possible values:
non-empty
and<= 200 characters
the endpoint where the JWT can be extracted
- issuer string required
Possible values:
non-empty
and<= 200 characters
the issuer of the JWT (for validation)
- keysEndpoint string required
Possible values:
non-empty
and<= 200 characters
the endpoint to the key (JWK) which is used to sign the JWT with
- headerName string required
Possible values:
non-empty
and<= 200 characters
the name of the header where the JWT is sent in, default is authorization
- autoRegister boolean
Request Body required
- name string required
Possible values:
non-empty
and<= 200 characters
- stylingType string
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
- jwtEndpoint string required
Possible values:
non-empty
and<= 200 characters
the endpoint where the JWT can be extracted
- issuer string required
Possible values:
non-empty
and<= 200 characters
the issuer of the JWT (for validation)
- keysEndpoint string required
Possible values:
non-empty
and<= 200 characters
the endpoint to the key (JWK) which is used to sign the JWT with
- headerName string required
Possible values:
non-empty
and<= 200 characters
the name of the header where the JWT is sent in, default is authorization
- autoRegister boolean
Request Body required
- name string required
Possible values:
non-empty
and<= 200 characters
- stylingType string
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
- jwtEndpoint string required
Possible values:
non-empty
and<= 200 characters
the endpoint where the JWT can be extracted
- issuer string required
Possible values:
non-empty
and<= 200 characters
the issuer of the JWT (for validation)
- keysEndpoint string required
Possible values:
non-empty
and<= 200 characters
the endpoint to the key (JWK) which is used to sign the JWT with
- headerName string required
Possible values:
non-empty
and<= 200 characters
the name of the header where the JWT is sent in, default is authorization
- autoRegister boolean
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to- idpId string
{
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
},
"idpId": "69234230193872955"
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to- idpId string
{
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
},
"idpId": "69234230193872955"
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to- idpId string
{
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
},
"idpId": "69234230193872955"
}
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"
}
]
}