Gigya Job Openings

accounts.tfa.backupcodes.get REST

Skip to end of metadata
Go to start of metadata


This method is part of a two-factor authentication (TFA) flow and is used to retrieve backup codes saved for a user in a time-based authentication flow. Note that TFA is part of Risk-Based Authentication (RBA).

 

This method is part of Customer Identity, a premium platform that require separate activation. If it is not part of your site package, contact your Gigya Customer Engagement Executive or contact us by filling in a support form on our site. You can also access the support page by clicking "Support" on the upper menu of Gigya's Console.

 

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
gigyaAssertionstringThe JWT token from accounts.tfa.initTFA. It is made up of a header object, a body object and a signature:
Header:

{
  "alg": "http://www.w3.org/2000/09/xmldsig#rsa-sha1",
  "typ": "JWT",
  "x5u": "http://accounts.gigya.com/accounts.tfa.getCertificate"
}

Body:

{
  iss - a string representing the issuer, e.g., "gigya.com". 
  aud - a string representing the TFA provider name, e.g., "gigyaPhone".
  sub - a string representing a unique Gigya identifier for this user.
  action - a string enum representing the requested action type, can be "verify", "edit", or "registerOrVerify".
  params - a JSON object with string properties and values with TFA provider-specific parameters. These are the params from the policy for this provider.
  iat - an integer representing the creation time of this JWT object in UNIX time.
  jti - a string representing the JWT ID; a crypto-strength nonce value.
  ctx - a string representing an encrypted Gigya context.
}

Signature: Computed using the private key matching the public key whose URL is specified in the header.

             
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 occurs.

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. 

 

Response Data

FieldTypeDescription
backupCodesarray of strings

An array of backup codes currently saved for this user. Note that used backup codes are not returned.

 
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.
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 that is not always returned and should not be relied upon by your implementation.
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
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": "37311446ce7d49439e9cf844f82a430b",
 "context": "R1678188694",
 "errorCode": 0,
 "apiVersion": 2,
 "statusCode": 200,
 "statusReason": "OK",
 "time": "2019-01-15T16:21:25.273Z",
 "backupCodes": [
   "18401682",
   "52799022",
   "56925067",
   "84524849",
   "99975609",
   "36534179",
   "93474422",
   "81757352",
   "42479386"
 ]
}

 

Additional Information

When TFA is required during Login, a temp device is saved for 1 minute so that if an account gets a pending registration error it will not need an additional TFA afterwards.