> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown. # IOrganizationUserService - Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md) - Kind: interface - Stability: alpha - Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/organization/users/index.ts > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > This service provides access to organization users. **Signature:** ```typescript export interface IOrganizationUserService ``` ## Methods | Method | Description | | --- | --- | | [addUsersToUserGroups(userIds, userGroupIds)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserserviceadduserstousergroups) | **_(ALPHA)_** Add users to multiple user groups. | | [createUser(user)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicecreateuser) | **_(ALPHA)_** Creates a new user. | | [createUserGroup(group)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicecreateusergroup) | **_(ALPHA)_** Create user group. | | [deleteUserGroups(ids)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicedeleteusergroups) | **_(ALPHA)_** Delete user groups by ID. | | [deleteUsers(ids)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicedeleteusers) | **_(ALPHA)_** Delete users by ID. | | [getUser(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicegetuser) | **_(ALPHA)_** Get user by ID. | | [getUserGroup(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicegetusergroup) | **_(ALPHA)_** Get user group by ID. | | [getUserGroups()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicegetusergroups) | **_(ALPHA)_** Get list of users groups. | | [getUserGroupsOfUser(userId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicegetusergroupsofuser) | **_(ALPHA)_** Get groups assigned to the user. | | [getUserGroupsQuery()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicegetusergroupsquery) | **_(ALPHA)_** List user groups. | | [getUserLocalizationSettings(userId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicegetuserlocalizationsettings) | **_(ALPHA)_** Get the languages a user set for themselves. | | [getUsers()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicegetusers) | **_(ALPHA)_** Get list of users. | | [getUsersByEmail(email)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicegetusersbyemail) | **_(ALPHA)_** Get user by email. | | [getUsersOfUserGroup(userGroupId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicegetusersofusergroup) | **_(ALPHA)_** Get users assigned to the user group. | | [getUsersQuery()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicegetusersquery) | **_(ALPHA)_** List users. | | [getUsersSummary()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicegetuserssummary) | **_(ALPHA)_** Get list of users with basic information only. This method provides a lightweight alternative to [IOrganizationUserService.getUsers()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicegetusers) that fetches only basic user information (id, email, name) | | [inviteUser(invitation)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserserviceinviteuser) | **_(ALPHA)_** Invite a user to the organization. The backend sends the invitation email. | | [removeUsersFromUserGroups(userIds, userGroupIds)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserserviceremoveusersfromusergroups) | **_(ALPHA)_** Remove users from user groups. | | [setUserLocalizationSetting(userId, type, value)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicesetuserlocalizationsetting) | **_(ALPHA)_** Set or remove a language a user has for themselves. | | [updateUser(user)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserserviceupdateuser) | **_(ALPHA)_** Update user. | | [updateUserGroup(group)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserserviceupdateusergroup) | **_(ALPHA)_** Update user group. | ## Method details ### IOrganizationUserService.addUsersToUserGroups() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Add users to multiple user groups. **Signature:** ```typescript addUsersToUserGroups(userIds: string[], userGroupIds: string[]): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | userIds | string[] | IDs of the users that will be assigned to user groups. | | userGroupIds | string[] | IDs of the users groups to which user will be assigned. | **Returns:** Promise<void> promise ### IOrganizationUserService.createUser() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Creates a new user. **Signature:** ```typescript createUser(user: IUser): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | user | [IUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md) | user to create | **Returns:** Promise<[IUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md)> ### IOrganizationUserService.createUserGroup() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Create user group. **Signature:** ```typescript createUserGroup(group: IUserGroup): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | group | [IUserGroup](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iusergroup/index.md) | The user group that must be created. | **Returns:** Promise<void> promise ### IOrganizationUserService.deleteUserGroups() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Delete user groups by ID. **Signature:** ```typescript deleteUserGroups(ids: string[]): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | ids | string[] | ID of the user group. | **Returns:** Promise<void> promise ### IOrganizationUserService.deleteUsers() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Delete users by ID. **Signature:** ```typescript deleteUsers(ids: string[]): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | ids | string[] | ID of the user. | **Returns:** Promise<void> promise ### IOrganizationUserService.getUser() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Get user by ID. **Signature:** ```typescript getUser(id: string): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | id | string | ID of the user. | **Returns:** Promise<[IUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md) | undefined> promise ### IOrganizationUserService.getUserGroup() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Get user group by ID. **Signature:** ```typescript getUserGroup(id: string): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | id | string | ID of the user group. | **Returns:** Promise<[IUserGroup](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iusergroup/index.md) | undefined> promise ### IOrganizationUserService.getUserGroups() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Get list of users groups. **Signature:** ```typescript getUserGroups(): Promise; ``` **Returns:** Promise<[IOrganizationUserGroup](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iorganizationusergroup/index.md)[]> promise ### IOrganizationUserService.getUserGroupsOfUser() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Get groups assigned to the user. **Signature:** ```typescript getUserGroupsOfUser(userId: string): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | userId | string | ID of the user. | **Returns:** Promise<[IUserGroup](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iusergroup/index.md)[]> promise ### IOrganizationUserService.getUserGroupsQuery() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > List user groups. **Signature:** ```typescript getUserGroupsQuery(): IOrganizationUserGroupsQuery; ``` **Returns:** [IOrganizationUserGroupsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationusergroupsquery/index.md) promise ### IOrganizationUserService.getUserLocalizationSettings() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Get the languages a user set for themselves. **Signature:** ```typescript getUserLocalizationSettings(userId: string): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | userId | string | ID of the user. | **Returns:** Promise<[IUserLocalizationSettings](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iuserlocalizationsettings/index.md)> promise with the settings the user has; types the user did not set are missing ### IOrganizationUserService.getUsers() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Get list of users. **Signature:** ```typescript getUsers(): Promise; ``` **Returns:** Promise<[IOrganizationUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iorganizationuser/index.md)[]> promise ### IOrganizationUserService.getUsersByEmail() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Get user by email. **Signature:** ```typescript getUsersByEmail(email: string): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | email | string | email of the user. | **Returns:** Promise<[IUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md)[]> promise of array of users ### IOrganizationUserService.getUsersOfUserGroup() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Get users assigned to the user group. **Signature:** ```typescript getUsersOfUserGroup(userGroupId: string): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | userGroupId | string | ID of the user group. | **Returns:** Promise<[IUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md)[]> promise ### IOrganizationUserService.getUsersQuery() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > List users. **Signature:** ```typescript getUsersQuery(): IOrganizationUsersQuery; ``` **Returns:** [IOrganizationUsersQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationusersquery/index.md) promise ### IOrganizationUserService.getUsersSummary() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Get list of users with basic information only. This method provides a lightweight alternative to [IOrganizationUserService.getUsers()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md#iorganizationuserservicegetusers) that fetches only basic user information (id, email, name) **Signature:** ```typescript getUsersSummary(): Promise; ``` **Returns:** Promise<[IOrganizationUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iorganizationuser/index.md)[]> promise ### IOrganizationUserService.inviteUser() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Invite a user to the organization. The backend sends the invitation email. **Signature:** ```typescript inviteUser(invitation: IUserInvitation): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | invitation | [IUserInvitation](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuserinvitation/index.md) | details of the invited user | **Returns:** Promise<void> promise that rejects when the backend does not accept the invitation ### IOrganizationUserService.removeUsersFromUserGroups() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Remove users from user groups. **Signature:** ```typescript removeUsersFromUserGroups(userIds: string[], userGroupIds: string[]): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | userIds | string[] | IDs of the users. | | userGroupIds | string[] | IDs of the user groups. | **Returns:** Promise<void> promise ### IOrganizationUserService.setUserLocalizationSetting() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Set or remove a language a user has for themselves. **Signature:** ```typescript setUserLocalizationSetting(userId: string, type: LocalizationSettingType, value: string | undefined): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | userId | string | ID of the user. | | type | [LocalizationSettingType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.localizationsettingtype/index.md) | the language setting to change. | | value | string \| undefined | the language code; `undefined` removes the setting, so the user follows each workspace. | **Returns:** Promise<void> promise ### IOrganizationUserService.updateUser() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Update user. **Signature:** ```typescript updateUser(user: IUser): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | user | [IUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md) | The user that must be updated. | **Returns:** Promise<void> promise ### IOrganizationUserService.updateUserGroup() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Update user group. **Signature:** ```typescript updateUserGroup(group: IUserGroup): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | group | [IUserGroup](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iusergroup/index.md) | The user group that must be updated. | **Returns:** Promise<void> promise