Function: removeUsersFromOrganization()
ts
function removeUsersFromOrganization(
client,
parameters,
options?
): Promise<void>;Defined in: src/serviceDesk/api/organization.ts:303
This method removes users from an organization.
Permissions required: Service desk administrator or agent. Note: Permission to delete users from an organization can be switched to users with the Jira administrator permission, using the Organization management feature.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { body: { accountIds?: string[]; organizationId?: number; usernames?: string[]; }; organizationId: number; } | - |
parameters.body | { accountIds?: string[]; organizationId?: number; usernames?: string[]; } | - |
parameters.body.accountIds? | string[] | List of customers, specific by account IDs, to add to or remove from the organization. |
parameters.body.organizationId? | number | The organizationId in which users need to be added |
parameters.body.usernames? | string[] | This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use accountIds instead. |
parameters.organizationId? | number | The ID of the organization. |
options? | RequestOptions | - |
Returns
Promise<void>