lib/client/sf-gate/docs/UsersApi.md

71 lines
2.0 KiB
Markdown
Raw Normal View History

2022-09-03 21:10:56 +00:00
# SfGate.UsersApi
All URIs are relative to *http://sf-gate.vernonkeenan.com:8080/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getUsers**](UsersApi.md#getUsers) | **GET** /users | Get a list Users
## getUsers
> UserResponse getUsers(opts)
Get a list Users
Return a list of User records from the datastore
### Example
```javascript
import SfGate from 'sf_gate';
let defaultClient = SfGate.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
let apiInstance = new SfGate.UsersApi();
let opts = {
'limit': 789, // Number | How many objects to return at one time
'offset': 789, // Number | How many objects to skip?
'userId': "userId_example", // String | Taxnexus Id of the User to be retrieved
'active': true, // Boolean | Only retrieve active records?
'apikey': "apikey_example" // String | Taxnexus Id of the User to be retrieved
};
apiInstance.getUsers(opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Number**| How many objects to return at one time | [optional]
**offset** | **Number**| How many objects to skip? | [optional]
**userId** | **String**| Taxnexus Id of the User to be retrieved | [optional]
**active** | **Boolean**| Only retrieve active records? | [optional]
**apikey** | **String**| Taxnexus Id of the User to be retrieved | [optional]
### Return type
[**UserResponse**](UserResponse.md)
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json