Function: getUsersInOrganization()
ts
function getUsersInOrganization(client, parameters): Promise<{
[key: string]: unknown;
_expands?: string[];
_links?: {
[key: string]: unknown;
base?: string;
context?: string;
next?: string;
prev?: string;
self?: string;
};
isLastPage?: boolean;
limit?: number;
size?: number;
start?: number;
values?: object[];
}>;Defined in: src/serviceDesk/api/organization.ts:213
This method returns all the users associated with an organization. Use this method where you want to provide a list of users for an organization or determine if a user is associated with an organization.
Permissions required: Service desk administrator or agent.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { limit?: number; organizationId: number; start?: number; } | - |
parameters.limit? | number | The maximum number of users to return per page. Default: 50. See the Pagination section for more details. |
parameters.organizationId | number | The ID of the organization. |
parameters.start? | number | The starting index of the returned objects. Base index: 0. See the Pagination section for more details. |
Returns
Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: object[]; }>