ObtainJwtAuthenticationTokenByDerivedShortToken - Identity as a Service

Obtain a JWT authentication token using a derived short token.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /v2/{instanceId}/authenticationTokens/_/actions/obtainJwtByDerivedShortToken HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	Instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	Request body.
derivedShortToken	string	Yes	Derived short token for the JWT authentication token.	sk-Nx2vzxxxxxxxxxxxxxxxxx

Response elements

Element	Type	Description	Example
	object	Details of the JWT authentication token.
instanceId	string	Instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
authenticationTokenId	string	Authentication token ID.	atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx
credentialProviderId	string	Credential provider ID.	atp_01kr2cmj5gxxx4fvmls2e93dxxxxx
createTime	integer	Creation time of the authentication token, as a UNIX timestamp in milliseconds.	1649830225000
updateTime	integer	Last update time of the authentication token, as a UNIX timestamp in milliseconds.	1649830225000
authenticationTokenType	string	Type of the authentication token. Note The value is always `jwt`, indicating a JWT authentication token.	jwt
revoked	boolean	Indicates whether the authentication token is revoked.	false
creatorType	string	Type of the authentication token creator. Valid values: application	application
creatorId	string	ID of the authentication token creator.	app_ngtkgrrxxxxktg5eao6z4xxxxx
consumerType	string	Type of the authentication token consumer. Valid values: application custom	custom
consumerId	string	ID of the authentication token consumer.	test_jwt_subject
expirationTime	integer	Expiration time of the authentication token, as a UNIX timestamp in milliseconds.	1772693568000
jwtContent	object	Content of the JWT authentication token.
jwtValue	string	JWT content.	eyJhbGciOixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
derivedShortToken	string	Derived short token for the JWT.	sk-Nx2vzxxxxxxxxxxxxxxxxx

Examples

Success response

JSON format

{
  "instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
  "authenticationTokenId": "atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx",
  "credentialProviderId": "atp_01kr2cmj5gxxx4fvmls2e93dxxxxx",
  "createTime": 1649830225000,
  "updateTime": 1649830225000,
  "authenticationTokenType": "jwt",
  "revoked": false,
  "creatorType": "application",
  "creatorId": "app_ngtkgrrxxxxktg5eao6z4xxxxx",
  "consumerType": "custom",
  "consumerId": "test_jwt_subject",
  "expirationTime": 1772693568000,
  "jwtContent": {
    "jwtValue": "eyJhbGciOixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "derivedShortToken": "sk-Nx2vzxxxxxxxxxxxxxxxxx"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.