This API retrieves the configuration of specified challenges. The method returns the list of challenges, their levels and the associated action descriptions.
Note: Only active challenges and actions are returned, unless specified otherwise by setting the includeDisabledChallenges parameter to true.
us1.gigya.com- For the US data center.
eu1- For the European data center.
au1- For the Australian data center.
ru1- For the Russian data center.
cn1- For the Chinese data center.
If you are not sure of your site's data center, see Finding Your Data Center.
Challenges to include in the response. The default value is '*', representing all the challenges that the site has to offer.
Note: Challenges that are listed in the excludedChallenges parameter are not displayed.
|||excludeChallenges||string||Challenges to exclude from the response . The default value is '' (empty string), meaning that no challenges that the site has to offer are to be excluded.|
|||lang||string||Specifies the language of strings to use in the returned text fields. If a specific field doesn't have a translation in the requested language, then the string from the default language is used. If this parameter is not specified, then the default language is used. If this field has the special value "all", then each text field is expanded to the object listing all the available languages for that string (the same way it is written to gm.setChallengeConfig).|
|||expandActions||Boolean||Indicates whether to expand the returned actions to include their full details, or only their actionIDs. The default value is 'false'.|
|||includeDisabledChallenges||Boolean||Indicates whether the method will return disabled challenges. The default value is 'false'.|
|||includeDisabledActions||Boolean||Indicates whether the method will return disabled actions. The default value is 'false'.|
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:
Please refer to the Authorization Parameters section for details.
|challenges||array||An array listing the challenges. Each challenge is represented by an object that includes the following fields:|
|actions||array||An array listing the same challengeActions that are associated with the challenge, but with additional global fields . The actions array is included in the response only if expandActions is set to 'true'. |
Each action is represented by an object that includes the following fields: