accounts.getJWTPublicKey REST

Skip to end of metadata
Go to start of metadata

Note: If you plan on integrating Gigya's Accounts API, we highly recommend reading the Registration-as-a-Service Guide. Registration-as-a-Service (RaaS) is a premium platform that requires separate activation. If RaaS is not part of your site package, please contact Gigya by filling in a support form through the Console. You can access the support page by clicking Support on the upper menu after logging into the Gigya Console.

Description

This API allows retrieval of the public key necessary for validating an id_token returned from the accounts.getJWT API endpoint. As a public endpoint, this API requires no parameters, including a secret or userKey/secret pair, and only the API key of the site for which to retrieve the public key.


Request URL

Where <Data_Center> is:
  • us1.gigya.com - For the US data center.
  • eu1.gigya.com - For the European data center.
  • au1.gigya.com - For the Australian data center.
  • ru1.gigya.com - For the Russian data center.
  • cn1.gigya-api.cn - For the Chinese data center.

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

 

Parameters

RequiredNameTypeDescription
apiKeystringThe API key of the site for which to return the public key.
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.
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.

Please refer to the Authorization Parameters section for details. 

 

Response Data

FieldTypeDescription
For additional information on the specifications and definitions of fields returned in a JWK, please see the official Proposed Standard.
ktystringSpecifies the Key type returned (cryptographic family).
algstringSpecifies the algorithm to be used with this key.
usestringDescribes the use of of the public key (to encrypt the data or verify the signature)
kidstringThe key id used to distinguish between multiple keys in a given set or array.
nstringThe modulus. A base64url encoding of the returned id_token.
estringThe exponent value for the RSA public key.
 
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
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.
statusReason string A brief explanation of the status code.
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.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter and not always returned.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or

 

 

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

 

Response Example

{
    "statusCode": 200,
    "errorCode": 0,
    "statusReason": "OK",
    "callId": "b9903932f64f4664a2de2949d1636a85",
    "time": "2016-12-06T18:27:27.499Z",
    "kty": "RSA",
    "alg": "RS256",
    "use": "sig",
    "kid": "c4c3e666b40*************ec5a824df1bfd449",
    "n": "0zLcDhqrrkHJCBJKtqAFIxqQtu-WcViGRDHC9O_*********************_zecuWmw34d_ZJf8PfQJaj_ulWDQgo4h_
          ChNqhRLkYOpz9QapX6ZULIillWP35_omuAeQjy9*********************O0F6JrnLpIF2hI8XYT4ES7udp0mHnAGZih
          lKToLH8OpViDuYLTpInsqxrLjRQWg5iB8EtVeys*********************fl8ozlwekdXarWgBg8-Ku_yxsz7Su4n5EK
          AoVMbhXNPASb6VfmFWemV_SA_TyxqZ-69HLu6wf*********************w",
    "e": "AQAB"
  }

 

  • No labels