SAP Customer Data Cloud Positions

accounts.getJWT REST

Skip to end of metadata
Go to start of metadata


Unable to render {include} The included page could not be found.


This API is used to obtain an id_token containing an existing user's data in JWS format . This id_token can then be transmitted between servers, enabling a partner to share a user's data among multiple sites/API keys. You can validate the JWT using the originating site's public key returned from accounts.getJWTPublicKey

accounts.getJWT requires an app or user key with full data access when being used via REST, see Data Field Access for more information.

Unable to render {include} The included page could not be found.

Request URL

Where <Data_Center>  is:
  • - For the US data center.
  • - For the European data center.
  • - For the Australian data center.
  •  - For the Russian data center.
  •  - For the Chinese data center.

If you are not sure of your site's data center, see Finding Your Data Center.


apiKeystringThe API key of the target site containing the existing user's data.

The partner secret or both an application/user key and it's corresponding secret.

*When passing an application/user key secret, you must also pass a userKey parameter that the secret is associated to.

targetUIDstringThe UID of the user whose data is being requested. Must be a user for the site of the associated apiKey (above).
userKey*stringThe userKey associated with the secret, if not using a partner secret.
fieldsstring, comma delimited

Any existing profile and/or data fields in the target site's database you want to explicitly return in the JWT for this targetUID.

When requesting profile fields, it is not necessary to prepend 'profile.' (e.g., profile.firstName can be passed as firstName).

expirationintegerThe TTL of the returned JWT, in seconds. If this parameter is not passed, the default is 300.
format string Determines the format of the response. The options are:
  • json (default)
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
callback string This parameter is required only when the format parameter is set to jsonp (see above). In such cases this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
context string/JSON This parameter may be used to pass data through the current method and return it, unchanged, within the response.
ignoreInterruptions Boolean This may be used in some cases to suppress logic applied by the Web SDK, such as automatic opening of screens (e.g., in a registration completion scenario). This parameter may not be used with REST APIs.
httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if one occurred.


Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:

  • accounts.login
  • socialize.login
  • accounts.notifyLogin
  • socialize.notifyLogin
  • accounts.finalizeRegistration
  • accounts.linkAccounts

Please refer to the Authorization Parameters section for details. 

Sample Requests


Response Data

id_tokenJSON Web TokenThe returned JWT containing the user's data.
ignoredFieldsstringIf any fields that were passed do not exist for the requested apiKey, they will be ignored and listed here.
apiVersion integer Defines the API version that returned the response and may not always be returned.
callId string Unique identifier of the transaction, for debugging purposes.
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter that is not always returned and should not be relied upon by your implementation.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
This property is deprecated and only returned for backward compatibility.
statusReason string A brief explanation of the status code.
This property is deprecated and only returned for backward compatibility.


A field that does not contain data will not appear in the response.


Response Example

  "callId": "1b0f125b7b904a2582340cfa89922ade",
  "errorCode": 0,
  "apiVersion": 2,
  "statusCode": 200,
  "statusReason": "OK",
  "time": "2016-12-18T11:23:36.315Z",
  "ignoredFields": "",
  "id_token": "eyJ0eXAiOi**************************ImtpZCI6IjdfY2VBQSJ9.eyJpc3MiOiJodHRwczov



Additional Information

Whenever relying on the contents of the response from accounts.getJWT, e.g., before adding the user's data to a new database, you should validate that the content has not been manipulated in transit. You can do that by validating the signature against the host site's public key. Please see Validate A JWT from SAP Customer Data Cloud for additional information.


The license could not be verified: License Certificate has expired!


  • No labels