IOrganizationUserService
Home > @gooddata/sdk-backend-spi > IOrganizationUserService
IOrganizationUserService interface
This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
This service provides access to organization users.
Signature:
export interface IOrganizationUserService
Methods
| Method | Description |
|---|---|
| addUsersToUserGroups(userIds, userGroupIds) | (ALPHA) Add users to multiple user groups. |
| createUser(user) | (ALPHA) Creates a new user. |
| createUserGroup(group) | (ALPHA) Create user group. |
| deleteUserGroups(ids) | (ALPHA) Delete user groups by ID. |
| deleteUsers(ids) | (ALPHA) Delete users by ID. |
| getUser(id) | (ALPHA) Get user by ID. |
| getUserGroup(id) | (ALPHA) Get user group by ID. |
| getUserGroups() | (ALPHA) Get list of users groups. |
| getUserGroupsOfUser(userId) | (ALPHA) Get groups assigned to the user. |
| getUserGroupsQuery() | (ALPHA) List user groups. |
| getUsers() | (ALPHA) Get list of users. |
| getUsersByEmail(email) | (ALPHA) Get user by email. |
| getUsersOfUserGroup(userGroupId) | (ALPHA) Get users assigned to the user group. |
| getUsersQuery() | (ALPHA) List users. |
| removeUsersFromUserGroups(userIds, userGroupIds) | (ALPHA) Remove users from user groups. |
| updateUser(user) | (ALPHA) Update user. |
| updateUserGroup(group) | (ALPHA) Update user group. |