Add JWT Identity Provider

POST 
https://$CUSTOM-DOMAIN/management/v1/idps/generic_jwt

Add JWT Identity Provider

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

Body

required

name string
issuer string
jwtEndpoint string
keysEndpoint string
headerName string

providerOptions

object

isLinkingAllowed boolean

Enable if users should be able to manually link an existing ZITADEL user with an external account. Disable if users should only be allowed to link the proposed account in case of active auto_linking.

isCreationAllowed boolean

Enable if users should be able to manually create a new account in ZITADEL when using an external account. Disable if users should not be able to edit account information when auto_creation is enabled.

isAutoCreation boolean

Enable if a new account in ZITADEL should be created automatically when login with an external account.

isAutoUpdate boolean

Enable if a the ZITADEL account fields should be updated automatically on each login.

autoLinking string

Possible values: [AUTO_LINKING_OPTION_UNSPECIFIED, AUTO_LINKING_OPTION_USERNAME, AUTO_LINKING_OPTION_EMAIL]

Default value: AUTO_LINKING_OPTION_UNSPECIFIED

Enable if users should get prompted to link an existing ZITADEL user to an external account if the selected attribute matches.

application/grpc

Body

required

name string
issuer string
jwtEndpoint string
keysEndpoint string
headerName string

providerOptions

object

isLinkingAllowed boolean

Enable if users should be able to manually link an existing ZITADEL user with an external account. Disable if users should only be allowed to link the proposed account in case of active auto_linking.

isCreationAllowed boolean

Enable if users should be able to manually create a new account in ZITADEL when using an external account. Disable if users should not be able to edit account information when auto_creation is enabled.

isAutoCreation boolean

Enable if a new account in ZITADEL should be created automatically when login with an external account.

isAutoUpdate boolean

Enable if a the ZITADEL account fields should be updated automatically on each login.

autoLinking string

Possible values: [AUTO_LINKING_OPTION_UNSPECIFIED, AUTO_LINKING_OPTION_USERNAME, AUTO_LINKING_OPTION_EMAIL]

Default value: AUTO_LINKING_OPTION_UNSPECIFIED

Enable if users should get prompted to link an existing ZITADEL user to an external account if the selected attribute matches.

application/grpc-web+proto

Body

required

name string
issuer string
jwtEndpoint string
keysEndpoint string
headerName string

providerOptions

object

isLinkingAllowed boolean

Enable if users should be able to manually link an existing ZITADEL user with an external account. Disable if users should only be allowed to link the proposed account in case of active auto_linking.

isCreationAllowed boolean

Enable if users should be able to manually create a new account in ZITADEL when using an external account. Disable if users should not be able to edit account information when auto_creation is enabled.

isAutoCreation boolean

Enable if a new account in ZITADEL should be created automatically when login with an external account.

isAutoUpdate boolean

Enable if a the ZITADEL account fields should be updated automatically on each login.

autoLinking string

Possible values: [AUTO_LINKING_OPTION_UNSPECIFIED, AUTO_LINKING_OPTION_USERNAME, AUTO_LINKING_OPTION_EMAIL]

Default value: AUTO_LINKING_OPTION_UNSPECIFIED

Enable if users should get prompted to link an existing ZITADEL user to an external account if the selected attribute matches.

Responses

200

A successful response.

application/json

Schema

Schema

details

object

sequence uint64

on 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-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)
id string

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2025-03-20T14:09:44.010Z",
    "changeDate": "2025-03-20T14:09:44.010Z",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}

application/grpc

Schema

Schema

details

object

sequence uint64

on 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-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)
id string

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2025-03-20T14:09:44.010Z",
    "changeDate": "2025-03-20T14:09:44.010Z",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}

application/grpc-web+proto

Schema

Schema

details

object

sequence uint64

on 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-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)
id string

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2025-03-20T14:09:44.010Z",
    "changeDate": "2025-03-20T14:09:44.010Z",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://$CUSTOM-DOMAIN/management/v1/idps/generic_jwt' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "string",
  "issuer": "My Provider",
  "jwtEndpoint": "string",
  "keysEndpoint": "string",
  "headerName": "string",
  "providerOptions": {
    "isLinkingAllowed": true,
    "isCreationAllowed": true,
    "isAutoCreation": true,
    "isAutoUpdate": true,
    "autoLinking": "AUTO_LINKING_OPTION_UNSPECIFIED"
  }
}'

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

{
  "name": "string",
  "issuer": "My Provider",
  "jwtEndpoint": "string",
  "keysEndpoint": "string",
  "headerName": "string",
  "providerOptions": {
    "isLinkingAllowed": true,
    "isCreationAllowed": true,
    "isAutoCreation": true,
    "isAutoUpdate": true,
    "autoLinking": "AUTO_LINKING_OPTION_UNSPECIFIED"
  }
}

ResponseClear

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