latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

admin-controller

Update JWT Settings (saveJwtSettings)

Updates the JWT Settings object that contains JWT token policy, etc. The tokenSigningKey field is a Base64 encoded string.

Available for users with 'SYS_ADMIN' authority.

post/api/admin/jwtSettings

Request body

tokenExpirationTimeinteger

The JWT will expire after seconds.

refreshTokenExpTimeinteger

The JWT can be refreshed during seconds.

tokenIssuerstring

The JWT issuer.

tokenSigningKeystring

The JWT key is used to sing token. Base64 encoded.

Example request

{
  "tokenExpirationTime": 9000,
  "refreshTokenExpTime": 604800,
  "tokenIssuer": "thingsboard.io",
  "tokenSigningKey": "dkVTUzU2M2VMWUNwVVltTUhQU2o5SUM0Tkc3M0k2Ykdwcm85QTl6R0RaQ252OFlmVDk2OEptZXBNcndGeExFZg=="
}

Response

OK

tokenstring

The JWT Access Token. Used to perform API calls.

refreshTokenstring

The JWT Refresh Token. Used to get new JWT Access Token if old one has expired.

scope'SYS_ADMIN' | 'TENANT_ADMIN' | 'CUSTOMER_USER' | 'REFRESH_TOKEN' | 'PRE_VERIFICATION_TOKEN' | 'MFA_CONFIGURATION_TOKEN'

Example response

{
  "token": "AAB254FF67D..",
  "refreshToken": "AAB254FF67D.."
}