Skip to content

Function: getUsers() ​

ts
function getUsers(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
  meta?: {
   [key: string]: unknown;
     total?: number;
  };
}>;

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

Returns a list of managed accounts in an organization.

Scopes ​

Authorization scopes required: read:accounts:admin

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ cursor?: string; orgId: string; }-
parameters.cursor?stringSets the starting point for the page of results to return.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; meta?: { [key: string]: unknown; total?: number; }; }>