Function getUserStats

getUserStats(
    client: Client,
    parameters: { directoryId: string; orgId: string },
    options?: RequestOptions,
): Promise<
    {
        accountStatus?: {
            count?: number;
            status?: "active"
            | "inactive"
            | "closed"
            | string & {};
            [key: string]: unknown;
        }[];
        roles?: { count?: number; roleId?: string; [key: string]: unknown }[];
        [key: string]: unknown;
    },
>
Return user stats for the organization.

Scopes

Authorization scopes required: read:directories:admin
Parameters
- client: Client
- parameters: { directoryId: string; orgId: string }
  - 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.
  - orgId: string
    
    Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        accountStatus?: {
            count?: number;
            status?: "active"
            | "inactive"
            | "closed"
            | string & {};
            [key: string]: unknown;
        }[];
        roles?: { count?: number; roleId?: string; [key: string]: unknown }[];
        [key: string]: unknown;
    },
>
- Defined in src/admin/api/users.ts:366