mirror of https://github.com/vernonkeenan/lib
61 lines
1.3 KiB
Markdown
61 lines
1.3 KiB
Markdown
|
# Board.UsersApi
|
||
|
|
|
||
|
|
All URIs are relative to *http://board.vernonkeenan.com:8080/v1*
|
||
|
|
|
||
|
|
Method | HTTP request | Description
|
||
|
|
------------- | ------------- | -------------
|
||
|
|
[**getUsers**](UsersApi.md#getUsers) | **GET** /users |
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## getUsers
|
||
|
|
|
||
|
|
> User getUsers(email)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Get a clean user record
|
||
|
|
|
||
|
|
### Example
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
import Board from 'board';
|
||
|
|
let defaultClient = Board.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 Board.UsersApi();
|
||
|
|
let email = "email_example"; // String | Email address
|
||
|
|
apiInstance.getUsers(email, (error, data, response) => {
|
||
|
|
if (error) {
|
||
|
|
console.error(error);
|
||
|
|
} else {
|
||
|
|
console.log('API called successfully. Returned data: ' + data);
|
||
|
|
}
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**email** | **String**| Email address |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**User**](User.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: Not defined
|
||
|
|
- **Accept**: application/json
|
||
|
|
|