Constructor
new Users(endPointopt, optionsopt)
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
endPoint |
String |
<optional> |
Cloud Controller API endpoint URL | |
options |
Object |
<optional> |
{} | Options (same as CloudControllerBase) |
- Source:
Methods
add(userOptions) → {Promise}
Create a User
Parameters:
| Name | Type | Description |
|---|---|---|
userOptions |
Object | User creation options |
- Source:
Returns:
Resolves with JSON user object
- Type
- Promise
getUser(guid) → {Promise}
Get a single User by GUID
Parameters:
| Name | Type | Description |
|---|---|---|
guid |
String | User unique identifier |
- Source:
Returns:
Resolves with JSON user object
- Type
- Promise
getUsers(filteropt) → {Promise}
Get Users list
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
filter |
Object |
<optional> |
Query-string filter options |
- Source:
Returns:
Resolves with JSON users list
- Type
- Promise
remove(guid) → {Promise}
Delete a User
Parameters:
| Name | Type | Description |
|---|---|---|
guid |
String | User unique identifier |
- Source:
Returns:
Resolves when user is deleted
- Type
- Promise