- Source:
Methods
(static) getAllUsers() → {promise}
Get all users from the user pool
- Source:
Returns:
- A promise that resolves to the user object with cleaned properties
- Type
- promise
(static) getGroupUsers(group) → {array}
Get all users from the specified user group
Parameters:
| Name | Type | Description |
|---|---|---|
group |
string | The name of the group to fetch users from |
- Source:
Returns:
- An array of users with cleaned properties
- Type
- array
(static) getUser(id) → {promise}
Get a user from the specified user ID
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The id of the user to fetch |
- Source:
Returns:
- A promise that resolves to the user object with cleaned properties
- Type
- promise
(static) getUserGroups(id) → {promise}
Get the groups a user belongs to
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the user to look up |
- Source:
Returns:
- A promise that resolves to an array of group names
- Type
- promise
(static) updateUserAttributes(id, attributes) → {promise}
Update a user's Cognito attributes
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the user to edit |
attributes |
object | The attributes to change |
- Source:
Returns:
- A promisethat resolves on completion
- Type
- promise