Renew JWT token

  • 1 minute(s) read
Prev Next
Post
/identity/users/me/renewToken

Renew the JWT using the Refresh Token and User Id from login.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Body parameters

The renew token body.

object

The payload message for renew token requests.

refreshToken
string

The renew token obtained during the user login.

Example{{refreshToken}}
userId
string

The identifier of the user gained the JWT token initially.

Example{{userId}}
tenantId
string

The tenant id.

Example{{tenantId}}
Responses
200

Renew succeeded.

object

The response message for renew token request.

token
string

The new JWT token to be used as bear token in the authenticated requets.

Example661fd29342541977c4002ec7...
tokenExpirationTimestamp
integer (int64)

The timestamp when the token will expire and must be refreshed.

Example1578438000000
refreshToken
string

The Refresh token to be used to obtain a new JWT token.

Examplecd2bd3a0-861d-4798-8fd6-2a2a99fb92e8
userId
string

The id of the authenticated user.

Example6616689a0de6d87b47cd6308
tenantId
string

The id of the target tenant.

Example661533a57bba156cf6e8d04b
400

Token cannot be renewed because not yet expired.

401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error