* This feature or API is being deprecated and should not be used in your implementation. If it already exists in your implementation, you should locate and remove it from your code by April 10th, 2017.
The API allows sites to export their users list. The method retrieves a list of users' data.
us1- For the US data center.
eu1- For the European data center.
au1- For the Australian data center.
ru1- For the Russian data center.
If you are not sure of your site's data center, see Finding Your Site's Data Center.
|||format||string||The preferred format of the returned user data. The options are:|
When format=csv the method returns a pure CSV of the result and automatically sets httpStatusCodes to 'true'.
A comma-separated list of fields to return in the response. Currently, the only supported values are: uid, provider, providerUID, and the default is "uid,provider,providerUID".
|||limit||integer||The maximum number of users to retrieve. It is not guaranteed that the number of users returned will be equal to the limit, it only guarantees that the number of returned users will not exceed the limit, even if the total number of site users is greater than the limit. By default, if no limit is defined then all users are returned.|
|||includePendingUsers||Boolean||Specifies whether the call to this method will include users who are in pendingRegistration status.|
Each REST API request must contain identification and authorization parameters.
The set of required parameters is dependent on your selected method of authorization. There are two options:
- If you are conforming with the OAuth 2.0 standard, you will need to Pass an Access Token. In this case, use a global access token that represents the application, not the user, by using socialize.getToken with grant_type=none. For more information, please read the Using Gigya's REST API in compliance with OAuth 2.0 guide.
- If you are using Gigya's proprietary authorization method, you will need to pass the parameters specified here. Or, if you are making a call over HTTPS then you may pass the secret parameter instead of the timestamp, nonce and sig parameters. For more information, please read the Using Gigya's REST API with our proprietary authorization method guide.
|users||array||An array of JSON objects that include:|
|usersCount||integer||The number of users that were returned.|
|identitiesCount||integer||The number of identities that were returned.|