Update JWT authentication configuration

put

http://127.0.0.1:8080/gmsRemoteAuth/JWT

Updates an existing JWT (JSON Web Token) authentication configuration. The configuration is identified by ID (not name). If cert is omitted, the existing certificate is preserved. Either the existing cert or a new cert/jwkUrl must be valid.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

integer

required

≥ 1

Unique identifier of the JWT configuration to update in the gmsConfig table.

Body Params

JWT configuration object with updated values. Required fields: name, issuer, auditor, userNameKey.

JWT configuration object for updating an existing SSO integration. Certificate is optional if the existing configuration has a valid cert or jwkUrl is provided.

name

string

required

Unique display name for this JWT configuration. Can be changed from the original name.

issuer

string

required

Expected 'iss' (issuer) claim value in the JWT token. Must match the token's issuer exactly.

auditor

string

required

Expected 'aud' (audience) claim value in the JWT token. Typically the client ID or API identifier.

userNameKey

string

required

JWT claim key that contains the username for login. Common values: 'email', 'preferred_username', 'sub'.

cert

string

PEM-encoded certificate for JWT signature verification. Optional - if omitted, existing certificate is preserved.

jwkUrl

uri

URL to the JSON Web Key Set (JWKS) endpoint. Can replace or be used alongside cert.

roleKey

string

JWT claim key containing RBAC role assignments. Set empty string to clear. Defaults to empty if null.

defaultRole

string

Default RBAC role assigned when roleKey claim is missing or empty in the token.

applianceAccessGroupKey

string

JWT claim key for RBAC appliance access group assignments. Defaults to empty if null.

validationWindow

integer

0 to 3600

Defaults to 0

Maximum allowed clock skew in seconds. Range: 0-3600. Defaults to 0 if null.

clientSecret

string

Client secret for OIDC 3-step authorization flow. Used with oidcUrl.

oidcUrl

uri

OIDC token endpoint URL for 3-step authorization flow.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

200JWT configuration updated successfully. The change is logged in the system action log.

400Invalid request - missing required parameters or invalid values.

401Unauthorized - User lacks READ_WRITE permission.

404JWT configuration not found for the specified ID.

500Internal server error during update operation.