Gigya Job Openings

accounts.tfa.getCertificate REST

Skip to end of metadata
Go to start of metadata

Description

This method retrieves Gigya's PEM-encoded X.509 certificate containing an RSA public key, which can be used to verify the signature on the JWT tokens Gigya issues.

 

Note: This method is part of the Customer Identity and the Identity Storage packages. Both packages are premium platforms that require separate activation. If neither are part of your site package, please 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 site.

 

 

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

 

certificatestringGigya's PEM-encoded X.509 certificate containing an RSA public key.

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

 

Response Example

-----BEGIN CERTIFICATE-----
MIIDvzCCAqegAwIBAgIJAPERfBTUmpLzMA0GCSqGSIb3DQEBBQUAMHYxCzAJBgNV
BAYTAklMMRMwEQYDVQQIDApTb21lLVN0YXRlMREwDwYDVQQHDAhUZWwtQXZpdjEO
MAwGA1UECgwFR2lneWExEjAQBgNVBAMMCWdpZ3lhLmNvbTEbMBkGCSqGSIb3DQEJ
ARYMaXRAZ2lneWEuY29tMB4XDTEzMTAwNzEwNDYxOFoXDTIzMTAwNTEwNDYxOFow
djELMAkGA1UEBhMCSUwxEzARBgNVBAgMClNvbWUtU3RhdGUxETAPBgNVBAcMCFRl
bC1Bdml2MQ4wDAYDVQQKDAVHaWd5YTESMBAGA1UEAwwJZ2lneWEuY29tMRswGQYJ
KoZIhvcNAQkBFgxpdEBnaWd5YS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw
ggEKAoIBAQDeZpvyUurv25gVlFo/GGqBXnrRC9/D8v74Nq5DlwwO6DfTR3M8PdQ8
WMJVuCBopx2BTkcVw5T3KAw/QzihyyaCQ+sNM7mHDttUsUXMD7IpRoSHP7M4VRBC
PeUitaAhKstCQv+g9nK2impMdqWrXhcEjyra5sJw0J8kFwlEmoALgId8zhUpn59Y
jS6N7a2hfivsxySpqbW+TSIy7UKTF5LYTLN5BzWkfSpN1sAbILwt1PX/HDvuoeF2
SSKZubwwfR8kjjF4hEhogC+riHMa7AKh4vjDm8glz0dH1YxLQFftieVlrd6w3s72
huPg79QVuz0rjSx2Ta9GJ2uedtWjGc21AgMBAAGjUDBOMB0GA1UdDgQWBBRJ64cZ
DLs8LyEIKKH3aWelxEOjGzAfBgNVHSMEGDAWgBRJ64cZDLs8LyEIKKH3aWelxEOj
GzAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQBCEUg5H7sRxN1ksppO
3ZI9av+ISdu/0TBdpMEn59925fEOMxqh7KlEmgNHKErFK4B/jAfA/yHBm9i7hhOa
1rvi1kpnL12adyODTalidRPYfuCRndVmbFNOzx/+w0QD3RnHzDVZv0FTFHOKFSSf
WPPtNzimRAdvMET67gLDT7C7LtoccvEmvt2gG/29YbvVPMnGLSwM+OCwEASH5+my
CZbt848FPxLBOfTrRtnCyTADpayxIlQrrHpWiLbC1jumb8Z+0tV9PEITrbCOfGbQ
hgKG9viNqL6iWH7PzOG8JgyxoQr2qQDmnJK7GiRBc+SYqYYZnD6kNxzPLRWX1who
6dua
-----END CERTIFICATE-----