IOrganizationUserService

IOrganizationUserService.addUsersToUserGroups()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Add users to multiple user groups.

addUsersToUserGroups(userIds: string[], userGroupIds: string[]): Promise<void>;

Parameters

Returns

Promise<void>

promise

IOrganizationUserService.createUser()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Creates a new user.

createUser(user: IUser): Promise<IUser>;

Parameters

Returns

Promise<IUser>

IOrganizationUserService.createUserGroup()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Create user group.

createUserGroup(group: IUserGroup): Promise<void>;

Parameters

Returns

Promise<void>

promise

IOrganizationUserService.deleteUserGroups()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Delete user groups by ID.

deleteUserGroups(ids: string[]): Promise<void>;

Parameters

Returns

Promise<void>

promise

IOrganizationUserService.deleteUsers()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Delete users by ID.

deleteUsers(ids: string[]): Promise<void>;

Parameters

Returns

Promise<void>

promise

IOrganizationUserService.getUser()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get user by ID.

getUser(id: string): Promise<IUser | undefined>;

Parameters

Returns

Promise<IUser | undefined>

promise

IOrganizationUserService.getUserGroup()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get user group by ID.

getUserGroup(id: string): Promise<IUserGroup | undefined>;

Parameters

Returns

Promise<IUserGroup | undefined>

promise

IOrganizationUserService.getUserGroups()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get list of users groups.

getUserGroups(): Promise<IOrganizationUserGroup[]>;

Returns

Promise<IOrganizationUserGroup[]>

promise

IOrganizationUserService.getUserGroupsOfUser()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get groups assigned to the user.

getUserGroupsOfUser(userId: string): Promise<IUserGroup[]>;

Parameters

Returns

Promise<IUserGroup[]>

promise

IOrganizationUserService.getUserGroupsQuery()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

List user groups.

getUserGroupsQuery(): IOrganizationUserGroupsQuery;

Returns

IOrganizationUserGroupsQuery

promise

IOrganizationUserService.getUserLocalizationSettings()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get the languages a user set for themselves.

getUserLocalizationSettings(userId: string): Promise<IUserLocalizationSettings>;

Parameters

Returns

Promise<IUserLocalizationSettings>

promise with the settings the user has; types the user did not set are missing

IOrganizationUserService.getUsers()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get list of users.

getUsers(): Promise<IOrganizationUser[]>;

Returns

Promise<IOrganizationUser[]>

promise

IOrganizationUserService.getUsersByEmail()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get user by email.

getUsersByEmail(email: string): Promise<IUser[]>;

Parameters

Returns

Promise<IUser[]>

promise of array of users

IOrganizationUserService.getUsersOfUserGroup()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get users assigned to the user group.

getUsersOfUserGroup(userGroupId: string): Promise<IUser[]>;

Parameters

Returns

Promise<IUser[]>

promise

IOrganizationUserService.getUsersQuery()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

List users.

getUsersQuery(): IOrganizationUsersQuery;

Returns

IOrganizationUsersQuery

promise

IOrganizationUserService.getUsersSummary()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get list of users with basic information only.

This method provides a lightweight alternative to IOrganizationUserService.getUsers() that fetches only basic user information (id, email, name)

getUsersSummary(): Promise<IOrganizationUser[]>;

Returns

Promise<IOrganizationUser[]>

promise

IOrganizationUserService.inviteUser()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Invite a user to the organization. The backend sends the invitation email.

inviteUser(invitation: IUserInvitation): Promise<void>;

Parameters

Returns

Promise<void>

promise that rejects when the backend does not accept the invitation

IOrganizationUserService.removeUsersFromUserGroups()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Remove users from user groups.

removeUsersFromUserGroups(userIds: string[], userGroupIds: string[]): Promise<void>;

Parameters

Returns

Promise<void>

promise

IOrganizationUserService.setUserLocalizationSetting()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Set or remove a language a user has for themselves.

setUserLocalizationSetting(userId: string, type: LocalizationSettingType, value: string | undefined): Promise<void>;

Parameters

Returns

Promise<void>

promise

IOrganizationUserService.updateUser()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Update user.

updateUser(user: IUser): Promise<void>;

Parameters

Returns

Promise<void>

promise

IOrganizationUserService.updateUserGroup()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Update user group.

updateUserGroup(group: IUserGroup): Promise<void>;

Parameters

Returns

Promise<void>

promise