Skip to content

Function: removeUserFromGroup() ​

ts
function removeUserFromGroup(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/cloud/api/groups.ts:123

Removes a user from a group.

Permissions required: Site administration (that is, member of the site-admin group).

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ accountId: string; groupId?: string; groupname?: string; }-
parameters.accountIdstringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.groupId?stringThe ID of the group. This parameter cannot be used with the groupName parameter.
parameters.groupname?stringAs a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter.
options?RequestOptions-

Returns ​

Promise<void>