Function: revokeGroupAccess()

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

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

Revoke a role from a group to remove access to an app from all members. A member can still access the app if they’re in another group that grants access to the same app.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ directoryId: string; groupId: string; orgId: string; resourceId: string; roleId: string; }	-
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.
parameters.resourceId?	string	A resource or workspace refers to a specific instance of an Atlassian app, which has a unique ID. Use the Get workspaces endpoint to find the resource ID.
parameters.roleId?	string	Valid values: atlassian/user, atlassian/user-access-admin, atlassian/admin, atlassian/guest, atlassian/contributor, atlassian/customer, atlassian/basic, atlassian/stakeholder, atlassian/viewer
options?	RequestOptions	-

Returns

Promise<void>