Skip to content

Function: revokeOrganizationRole() ​

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

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

Remove an organization-level role from a user. These are roles that have organization-wide privileges, like organization admin.

This operation follows eventual consistency. Changes may take up to 30 seconds to be reflected after the operation is performed.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ orgId: string; role: string & object | "atlassian/org-admin"; userId: string; }-
parameters.orgIdstringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.role?string & object | "atlassian/org-admin"-
parameters.userId?stringEvery user has a unique ID. Find a user's account ID by using the Get users endpoint.
options?RequestOptions-

Returns ​

Promise<void>