Update JWT customizer
Update the JWT customizer for the given token type.
Path parameters
-
The token type to update a JWT customizer for.
Values are
access-token
orclient-credentials
.
Body Required
-
The script of the JWT customizer.
-
The environment variables for the JWT customizer.
-
The sample context for the JWT customizer script testing purpose.
-
The sample raw token payload for the JWT customizer script testing purpose.
PATCH /api/configs/jwt-customizer/{tokenTypePath}
curl \
-X PATCH https://[tenant_id].logto.app/api/configs/jwt-customizer/{tokenTypePath} \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json"
Request examples
{}
Response examples (200)
Object-1 (generated)
{
"script": "string",
"environmentVariables": {
"key": "string"
},
"contextSample": {
"user": {
"id": "string",
"username": "string",
"primaryEmail": "string",
"primaryPhone": "string",
"name": "string",
"avatar": "string",
"customData": {},
"identities": {
"userId": "string",
"details": {}
},
"lastSignInAt": 42.0,
"createdAt": 42.0,
"updatedAt": 42.0,
"profile": {
"familyName": "string",
"givenName": "string",
"middleName": "string",
"nickname": "string",
"preferredUsername": "string",
"profile": "string",
"website": "string",
"gender": "string",
"birthdate": "string",
"zoneinfo": "string",
"locale": "string",
"address": {
"formatted": "string",
"streetAddress": "string",
"locality": "string",
"region": "string",
"postalCode": "string",
"country": "string"
}
},
"applicationId": "string",
"isSuspended": true,
"hasPassword": true,
"ssoIdentities": [
{
"issuer": "string",
"identityId": "string",
"detail": {}
}
],
"mfaVerificationFactors": [
"Totp"
],
"roles": [
{
"id": "string",
"name": "string",
"description": "string",
"scopes": [
{
"id": "string",
"name": "string",
"description": "string",
"resourceId": "string",
"resource": {
"tenantId": "string",
"id": "string",
"name": "string",
"indicator": "string",
"isDefault": true,
"accessTokenTtl": 42.0
}
}
]
}
],
"organizations": [
{
"id": "string",
"name": "string",
"description": "string"
}
],
"organizationRoles": [
{
"organizationId": "string",
"roleId": "string",
"roleName": "string"
}
]
},
"grant": {
"type": "string",
"subjectTokenContext": {}
}
},
"tokenSample": {
"jti": "string",
"aud": "string",
"scope": "string",
"clientId": "string",
"accountId": "string",
"expiresWithSession": true,
"grantId": "string",
"gty": "string",
"sessionUid": "string",
"sid": "string",
"kind": "string"
}
}
{
"script": "string",
"environmentVariables": {
"key": "string"
},
"contextSample": {},
"tokenSample": {
"jti": "string",
"aud": "string",
"scope": "string",
"clientId": "string",
"kind": "string"
}
}