Function: getUsers()

function getUsers(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  itemsPerPage?: number;
  Resources?: object[];
  schemas?: string[];
  startIndex?: number;
  totalResults?: number;
}>;

Defined in: src/userProvisioning/api/users.ts:126

Get users from the specified directory. Filtering is supported with a single exact match (eq) against the userName and externalId attributes.

Note: While this API enables pagination, sorting functionality is not supported.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ attributes?: string; count?: number; directoryId: string; excludedAttributes?: string; filter?: string; startIndex?: number; }	-
parameters.attributes?	string	Resource attributes to be included in response. Mutually exclusive from excludedAttributes. Example: userName,emails.value
parameters.count?	number	Desired maximum number of query results in the list response page.
parameters.directoryId?	string	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
parameters.excludedAttributes?	string	Resource attributes to be excluded from response. Mutually exclusive from attributes. Example: timezone,emails.type,department
parameters.filter?	string	Filter for userName or externalId. Example: userName eq "Atlassian"
parameters.startIndex?	number	A 1-based index of the first query result.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; itemsPerPage?: number; Resources?: object[]; schemas?: string[]; startIndex?: number; totalResults?: number; }>