published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a single JWT template in a Descope project. A JWT template customizes the claims in the JWTs that are generated for user sessions or access keys, and can be referenced from the project’s token settings.
Create JwtTemplate Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new JwtTemplate(name: string, args: JwtTemplateArgs, opts?: CustomResourceOptions);@overload
def JwtTemplate(resource_name: str,
args: JwtTemplateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def JwtTemplate(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
type: Optional[str] = None,
template: Optional[str] = None,
enforce_issuer: Optional[bool] = None,
description: Optional[str] = None,
empty_claim_policy: Optional[str] = None,
add_jti_claim: Optional[bool] = None,
exclude_permission_claim: Optional[bool] = None,
issuer_type: Optional[str] = None,
name: Optional[str] = None,
override_subject_claim: Optional[bool] = None,
conformance_issuer: Optional[bool] = None,
auto_tenant_claim: Optional[bool] = None,
auth_schema: Optional[str] = None)func NewJwtTemplate(ctx *Context, name string, args JwtTemplateArgs, opts ...ResourceOption) (*JwtTemplate, error)public JwtTemplate(string name, JwtTemplateArgs args, CustomResourceOptions? opts = null)
public JwtTemplate(String name, JwtTemplateArgs args)
public JwtTemplate(String name, JwtTemplateArgs args, CustomResourceOptions options)
type: descope:JwtTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_jwt_template" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args JwtTemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args JwtTemplateArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args JwtTemplateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args JwtTemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args JwtTemplateArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var jwtTemplateResource = new Descope.JwtTemplate("jwtTemplateResource", new()
{
ProjectId = "string",
Type = "string",
Template = "string",
EnforceIssuer = false,
Description = "string",
EmptyClaimPolicy = "string",
AddJtiClaim = false,
ExcludePermissionClaim = false,
IssuerType = "string",
Name = "string",
OverrideSubjectClaim = false,
ConformanceIssuer = false,
AutoTenantClaim = false,
AuthSchema = "string",
});
example, err := descope.NewJwtTemplate(ctx, "jwtTemplateResource", &descope.JwtTemplateArgs{
ProjectId: pulumi.String("string"),
Type: pulumi.String("string"),
Template: pulumi.String("string"),
EnforceIssuer: pulumi.Bool(false),
Description: pulumi.String("string"),
EmptyClaimPolicy: pulumi.String("string"),
AddJtiClaim: pulumi.Bool(false),
ExcludePermissionClaim: pulumi.Bool(false),
IssuerType: pulumi.String("string"),
Name: pulumi.String("string"),
OverrideSubjectClaim: pulumi.Bool(false),
ConformanceIssuer: pulumi.Bool(false),
AutoTenantClaim: pulumi.Bool(false),
AuthSchema: pulumi.String("string"),
})
resource "descope_jwt_template" "jwtTemplateResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
type = "string"
template = "string"
enforce_issuer = false
description = "string"
empty_claim_policy = "string"
add_jti_claim = false
exclude_permission_claim = false
issuer_type = "string"
name = "string"
override_subject_claim = false
conformance_issuer = false
auto_tenant_claim = false
auth_schema = "string"
}
var jwtTemplateResource = new JwtTemplate("jwtTemplateResource", JwtTemplateArgs.builder()
.projectId("string")
.type("string")
.template("string")
.enforceIssuer(false)
.description("string")
.emptyClaimPolicy("string")
.addJtiClaim(false)
.excludePermissionClaim(false)
.issuerType("string")
.name("string")
.overrideSubjectClaim(false)
.conformanceIssuer(false)
.autoTenantClaim(false)
.authSchema("string")
.build());
jwt_template_resource = descope.JwtTemplate("jwtTemplateResource",
project_id="string",
type="string",
template="string",
enforce_issuer=False,
description="string",
empty_claim_policy="string",
add_jti_claim=False,
exclude_permission_claim=False,
issuer_type="string",
name="string",
override_subject_claim=False,
conformance_issuer=False,
auto_tenant_claim=False,
auth_schema="string")
const jwtTemplateResource = new descope.JwtTemplate("jwtTemplateResource", {
projectId: "string",
type: "string",
template: "string",
enforceIssuer: false,
description: "string",
emptyClaimPolicy: "string",
addJtiClaim: false,
excludePermissionClaim: false,
issuerType: "string",
name: "string",
overrideSubjectClaim: false,
conformanceIssuer: false,
autoTenantClaim: false,
authSchema: "string",
});
type: descope:JwtTemplate
properties:
addJtiClaim: false
authSchema: string
autoTenantClaim: false
conformanceIssuer: false
description: string
emptyClaimPolicy: string
enforceIssuer: false
excludePermissionClaim: false
issuerType: string
name: string
overrideSubjectClaim: false
projectId: string
template: string
type: string
JwtTemplate Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The JwtTemplate resource accepts the following input properties:
- Project
Id string - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- Template string
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - Type string
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template. - Add
Jti boolClaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- Auth
Schema string - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - Auto
Tenant boolClaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - Conformance
Issuer bool - Whether to use OIDC conformance for the JWT issuer field.
- Description string
- Description of the JWT template.
- Empty
Claim stringPolicy - Policy for empty claims -
none,nilordelete. - Enforce
Issuer bool - Whether to enforce that the JWT issuer matches the project configuration.
- Exclude
Permission boolClaim - When enabled, permissions will not be included in the JWT token.
- Issuer
Type string - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - Name string
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- Override
Subject boolClaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID.
- Project
Id string - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- Template string
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - Type string
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template. - Add
Jti boolClaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- Auth
Schema string - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - Auto
Tenant boolClaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - Conformance
Issuer bool - Whether to use OIDC conformance for the JWT issuer field.
- Description string
- Description of the JWT template.
- Empty
Claim stringPolicy - Policy for empty claims -
none,nilordelete. - Enforce
Issuer bool - Whether to enforce that the JWT issuer matches the project configuration.
- Exclude
Permission boolClaim - When enabled, permissions will not be included in the JWT token.
- Issuer
Type string - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - Name string
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- Override
Subject boolClaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID.
- project_
id string - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- template string
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - type string
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template. - add_
jti_ boolclaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- auth_
schema string - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - auto_
tenant_ boolclaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - conformance_
issuer bool - Whether to use OIDC conformance for the JWT issuer field.
- description string
- Description of the JWT template.
- empty_
claim_ stringpolicy - Policy for empty claims -
none,nilordelete. - enforce_
issuer bool - Whether to enforce that the JWT issuer matches the project configuration.
- exclude_
permission_ boolclaim - When enabled, permissions will not be included in the JWT token.
- issuer_
type string - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - name string
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- override_
subject_ boolclaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID.
- project
Id String - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- template String
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - type String
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template. - add
Jti BooleanClaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- auth
Schema String - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - auto
Tenant BooleanClaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - conformance
Issuer Boolean - Whether to use OIDC conformance for the JWT issuer field.
- description String
- Description of the JWT template.
- empty
Claim StringPolicy - Policy for empty claims -
none,nilordelete. - enforce
Issuer Boolean - Whether to enforce that the JWT issuer matches the project configuration.
- exclude
Permission BooleanClaim - When enabled, permissions will not be included in the JWT token.
- issuer
Type String - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - name String
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- override
Subject BooleanClaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID.
- project
Id string - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- template string
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - type string
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template. - add
Jti booleanClaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- auth
Schema string - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - auto
Tenant booleanClaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - conformance
Issuer boolean - Whether to use OIDC conformance for the JWT issuer field.
- description string
- Description of the JWT template.
- empty
Claim stringPolicy - Policy for empty claims -
none,nilordelete. - enforce
Issuer boolean - Whether to enforce that the JWT issuer matches the project configuration.
- exclude
Permission booleanClaim - When enabled, permissions will not be included in the JWT token.
- issuer
Type string - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - name string
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- override
Subject booleanClaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID.
- project_
id str - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- template str
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - type str
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template. - add_
jti_ boolclaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- auth_
schema str - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - auto_
tenant_ boolclaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - conformance_
issuer bool - Whether to use OIDC conformance for the JWT issuer field.
- description str
- Description of the JWT template.
- empty_
claim_ strpolicy - Policy for empty claims -
none,nilordelete. - enforce_
issuer bool - Whether to enforce that the JWT issuer matches the project configuration.
- exclude_
permission_ boolclaim - When enabled, permissions will not be included in the JWT token.
- issuer_
type str - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - name str
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- override_
subject_ boolclaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID.
- project
Id String - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- template String
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - type String
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template. - add
Jti BooleanClaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- auth
Schema String - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - auto
Tenant BooleanClaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - conformance
Issuer Boolean - Whether to use OIDC conformance for the JWT issuer field.
- description String
- Description of the JWT template.
- empty
Claim StringPolicy - Policy for empty claims -
none,nilordelete. - enforce
Issuer Boolean - Whether to enforce that the JWT issuer matches the project configuration.
- exclude
Permission BooleanClaim - When enabled, permissions will not be included in the JWT token.
- issuer
Type String - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - name String
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- override
Subject BooleanClaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID.
Outputs
All input properties are implicitly available as output properties. Additionally, the JwtTemplate resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing JwtTemplate Resource
Get an existing JwtTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: JwtTemplateState, opts?: CustomResourceOptions): JwtTemplate@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
add_jti_claim: Optional[bool] = None,
auth_schema: Optional[str] = None,
auto_tenant_claim: Optional[bool] = None,
conformance_issuer: Optional[bool] = None,
description: Optional[str] = None,
empty_claim_policy: Optional[str] = None,
enforce_issuer: Optional[bool] = None,
exclude_permission_claim: Optional[bool] = None,
issuer_type: Optional[str] = None,
name: Optional[str] = None,
override_subject_claim: Optional[bool] = None,
project_id: Optional[str] = None,
template: Optional[str] = None,
type: Optional[str] = None) -> JwtTemplatefunc GetJwtTemplate(ctx *Context, name string, id IDInput, state *JwtTemplateState, opts ...ResourceOption) (*JwtTemplate, error)public static JwtTemplate Get(string name, Input<string> id, JwtTemplateState? state, CustomResourceOptions? opts = null)public static JwtTemplate get(String name, Output<String> id, JwtTemplateState state, CustomResourceOptions options)resources: existingJwtTemplate: type: descope:JwtTemplate get: id: ${id}import {
to = descope_jwt_template.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state JwtTemplateState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state JwtTemplateState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state JwtTemplateState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state JwtTemplateState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Add
Jti boolClaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- Auth
Schema string - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - Auto
Tenant boolClaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - Conformance
Issuer bool - Whether to use OIDC conformance for the JWT issuer field.
- Description string
- Description of the JWT template.
- Empty
Claim stringPolicy - Policy for empty claims -
none,nilordelete. - Enforce
Issuer bool - Whether to enforce that the JWT issuer matches the project configuration.
- Exclude
Permission boolClaim - When enabled, permissions will not be included in the JWT token.
- Issuer
Type string - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - Name string
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- Override
Subject boolClaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID. - Project
Id string - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- Template string
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - Type string
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template.
- Add
Jti boolClaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- Auth
Schema string - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - Auto
Tenant boolClaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - Conformance
Issuer bool - Whether to use OIDC conformance for the JWT issuer field.
- Description string
- Description of the JWT template.
- Empty
Claim stringPolicy - Policy for empty claims -
none,nilordelete. - Enforce
Issuer bool - Whether to enforce that the JWT issuer matches the project configuration.
- Exclude
Permission boolClaim - When enabled, permissions will not be included in the JWT token.
- Issuer
Type string - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - Name string
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- Override
Subject boolClaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID. - Project
Id string - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- Template string
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - Type string
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template.
- add_
jti_ boolclaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- auth_
schema string - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - auto_
tenant_ boolclaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - conformance_
issuer bool - Whether to use OIDC conformance for the JWT issuer field.
- description string
- Description of the JWT template.
- empty_
claim_ stringpolicy - Policy for empty claims -
none,nilordelete. - enforce_
issuer bool - Whether to enforce that the JWT issuer matches the project configuration.
- exclude_
permission_ boolclaim - When enabled, permissions will not be included in the JWT token.
- issuer_
type string - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - name string
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- override_
subject_ boolclaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID. - project_
id string - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- template string
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - type string
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template.
- add
Jti BooleanClaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- auth
Schema String - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - auto
Tenant BooleanClaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - conformance
Issuer Boolean - Whether to use OIDC conformance for the JWT issuer field.
- description String
- Description of the JWT template.
- empty
Claim StringPolicy - Policy for empty claims -
none,nilordelete. - enforce
Issuer Boolean - Whether to enforce that the JWT issuer matches the project configuration.
- exclude
Permission BooleanClaim - When enabled, permissions will not be included in the JWT token.
- issuer
Type String - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - name String
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- override
Subject BooleanClaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID. - project
Id String - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- template String
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - type String
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template.
- add
Jti booleanClaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- auth
Schema string - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - auto
Tenant booleanClaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - conformance
Issuer boolean - Whether to use OIDC conformance for the JWT issuer field.
- description string
- Description of the JWT template.
- empty
Claim stringPolicy - Policy for empty claims -
none,nilordelete. - enforce
Issuer boolean - Whether to enforce that the JWT issuer matches the project configuration.
- exclude
Permission booleanClaim - When enabled, permissions will not be included in the JWT token.
- issuer
Type string - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - name string
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- override
Subject booleanClaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID. - project
Id string - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- template string
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - type string
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template.
- add_
jti_ boolclaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- auth_
schema str - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - auto_
tenant_ boolclaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - conformance_
issuer bool - Whether to use OIDC conformance for the JWT issuer field.
- description str
- Description of the JWT template.
- empty_
claim_ strpolicy - Policy for empty claims -
none,nilordelete. - enforce_
issuer bool - Whether to enforce that the JWT issuer matches the project configuration.
- exclude_
permission_ boolclaim - When enabled, permissions will not be included in the JWT token.
- issuer_
type str - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - name str
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- override_
subject_ boolclaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID. - project_
id str - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- template str
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - type str
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template.
- add
Jti BooleanClaim - When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
- auth
Schema String - The authorization claims format -
default,tenantOnlyornone. Read more about schema types here. - auto
Tenant BooleanClaim - When a user is associated with a single tenant, the tenant will be set as the user's active tenant, using the
dct(Descope Current Tenant) claim in their JWT. - conformance
Issuer Boolean - Whether to use OIDC conformance for the JWT issuer field.
- description String
- Description of the JWT template.
- empty
Claim StringPolicy - Policy for empty claims -
none,nilordelete. - enforce
Issuer Boolean - Whether to enforce that the JWT issuer matches the project configuration.
- exclude
Permission BooleanClaim - When enabled, permissions will not be included in the JWT token.
- issuer
Type String - The issuer format for the JWT -
legacy,inboundorfederated. Thefederatedissuer type cannot be combined with theconformanceIssuerattribute. - name String
- Name of the JWT template. Must be unique among the project's JWT templates of both types.
- override
Subject BooleanClaim - Switching on will allow you to add a custom subject claim to the JWT. A default new
dsubclaim will be added with the user ID. - project
Id String - The ID of the project that this JWT template belongs to. Changing this value will require the resource to be deleted and recreated.
- template String
- The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a
stringvalue, preferably with thejsonencodefunction so the value converges with what the Descope service returns. - type String
- The kind of tokens this template applies to -
userfor user session JWTs orkeyfor access key JWTs. This value can be changed in place without recreating the template.
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope