accounts.extensions.create REST

Skip to end of metadata
Go to start of metadata

Description

This API creates a new empty and disabled Identity Extensibility Extension. You can only have a single Extension for any available Extension Point. Attempting to use this API when an extension already exists, will return an error; you must first use extensions.delete to remove the existing endpoint.

This parameter or feature is part of our Early Adopters Program. To find out if you are eligible for participation, contact your Account Manager by filling out a support form. You can access the support page by clicking Support on the upper menu after logging into your Gigya 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
extensionFuncUrlstringThe URL where the code data file of the Extension is located.
friendlyNamestring

The custom friendly name that will define this Extension.

extensionPointstring

The event that this Extension is connected to. This must be a single one of the following supported Extension Points:

  • OnBeforeAccountsRegister
  • OnBeforeAccountsLogin
  • OnBeforeSetAccountInfo
  • OnBeforeSocialLogin
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.
dontHandleScreenSet Boolean This parameter may be used in order to suppress the showing of screen-sets as a result of API calls. Default is false.
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 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

In the following code examples, all references to secret or secretKey are referring to the secret that corresponds to the userKey (Application key) provided in the request, and NOT to your Partner secret located in the Gigya Dashboard.

 

Response Data

FieldTypeDescription
resultJSON object

A JSON object including the details for the requested Extension and includes:

  • extensionId - (string) The Gigya defined ID of the Extension.
  • friendlyName - (string) The friendly name of the Extension.
  • enabled - (Boolean) The current status of the Extension.
 
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 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

 

 

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

Response Example

{
  "result": [
    {
      "extensionId": "123",
      "friendlyName": "Check password strength",
      "enabled": false
    }
  ],
  "apiVersion": 2,
  "callId": "07f707fe517c4e3c88eb1cdc01d3a29b",
  "statusCode": 200,
  "statusReason": "OK",
  "time": "2017-11-06T10:43:23.278Z",
  "errorCode": 0
}

 

 

  • No labels