Function: removeUserFromGroup()

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

Defined in: src/admin/api/groups.ts:180

Remove a user from a group. This removes any app access and permissions granted by this group, but the user may still be in other groups that grant the same app access and permissions.

Note: Removing a user from the org-admins group through this API will no longer revoke organization admin access. To revoke the organization admin role, use the Remove organization-level role endpoint instead. This applies to all organizations. For more information, see this community post.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ accountId: string; directoryId: string; groupId: string; orgId: string; }	-
parameters.accountId	string	Every user has a unique ID. Find a user’s account ID by using the Get users endpoint.
parameters.directoryId?	string	A directory has a unique ID. Use the Get directories endpoint to find the directory ID.
parameters.groupId?	string	A group has a unique ID. Use the Get groups endpoint to find the group ID.
parameters.orgId?	string	Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?	RequestOptions	-

Returns

Promise<void>