Function: revokeUserAccess()

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

Defined in: src/admin/api/users.ts:186

This API can be used to revoke Platform Roles from a user.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ orgId: string; resource?: string; role: | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder"; userId: string; }	-
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.resource?	string	Use the Get Workspaces API to get an id. Resource is required for all roles other than org-admin. Any resource passed for org-admin shall be ignored
parameters.role?	| string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder"	Role to assign/revoke for a user
parameters.userId?	string	The UserId on which the action(Role Revoke) needs to happen. Use the Search for users within an organization API to get the userId.
options?	RequestOptions	-

Returns

Promise<void>