Function: getUserStats()

function getUserStats(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  accountStatus?: object[];
  roles?: object[];
}>;

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

Return user stats for the organization.

Scopes

Authorization scopes required: read:directories:admin

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ directoryId: string; orgId: string; }	-
parameters.directoryId	string	Unique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
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<{ [key: string]: unknown; accountStatus?: object[]; roles?: object[]; }>