Gigya Job Openings

Page History

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 

Panel
borderColor#81C0FC
bgColor#F4F7FC
borderWidth1
borderStylesolid

Note: This method is part of the Registration-as-a-ServiceCustomer Identity and the Profile Management - IDS packages. Both packages are premium platforms that require separate activation. If neither are part of your site package, please contact your Gigya

Excerpt Include
Account Manager CS Title Excerpt Template
Account Manager CS Title Excerpt Template
nopaneltrue
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.

 

...

RequiredNameTypeDescription
Yes
querystringAn SQL-like query specifying the data to retrieve. Please refer to the Query language specification section above.
The following parameters are Required only when calling the search method from client side (i.e., Mobile SDKs): 
Yes
querySigstringAn HMAC_SHA1 signature proving that the search call is in fact coming from your client application, in order to prevent fraud. Follow the instructions in Constructing a Signature using the following base-string:  query  + "_" +  expTime . When using cursors, this parameter should only be sent with the initial request and omitted from subsequent requests. *When using querySig the openCursor property is not supported. openCursor is only supported in server-to-server calls that include a userKey and secret.

Yes

expTimestringThe GMT time when the signature, provided in the UIDSig parameter, should expire. The expected format is the Unix time format including milliseconds (i.e., the number of seconds since Jan. 1st 1970 * 1000). Gigya checks the time when the search request is received. If the time succeeds expTime, the request is considered forged.
 
No
openCursorBoolean

When set to true, the search response will include, in addition to the first page, another field named nextCursorId, which is used to fetch the next batch of results. This parameter should only be used on the first request and later should be removed from the request. When openCursor is active, the Limit clause sets the number of results returned in the batch and should not be larger than 1000 (one thousand).

Notes:

  • When using a cursor with a  Limit  set, the number of results in a batch is not guaranteed.
  • You cannot use a cursor if you have a group by or when using 'start'.
  • openCursor is not supported when using querySig and can only be used in server-to-server calls that include a userKey and secret.
No
cursorIdstring

The cursor ID that contains the nextCursorId value received in the first search call.

Notes:

  • You cannot pass both cursorId and query on the same request - cursorId brings the next page for the search for which it was opened. Also, the time between search requests using a cursorId must not exceed 5 minutes (300 seconds).
  • Each request should contain a different cursorId obtained from the response of the previous request (not the first) using the nextCursorId field. The exception to this rule is when a request fails or when a particular result set needs to be resent; in this case, resend the same cursorID (as long as it has not expired) to receive its associated result set.
No
timeoutintegerThe timeout for the request (in milliseconds). Default value is 20000 (20 seconds). Maximum allowed value is 60000 (60 seconds).
No
restrictedQuerystringAn SQL-like query specifying the data to retrieve. When using this parameter, the query specified must meet the regex criteria defined for the user making this call.
No
accountTypesstring

The type of account to retrieve: full or lite. Acceptable values:

  • full (the default value)
  • lite
  • full,lite

Include Page
Template_gs REST api common optional parameters new
Template_gs REST api common optional parameters new

...