Function getUserList

getUserList(
    client: Client,
    parameters?: { cursor?: number; maxResults?: number },
    options?: RequestOptions,
): Promise<
    {
        isLast?: boolean;
        maxResults?: number;
        nextCursor?: string;
        nextPage?: string;
        self?: string;
        values?: Record<string, any>[];
        [key: string]: unknown;
    },
>
Returns a list of all users. This resource cannot be accessed anonymously. This Api is a streaming-like endpoint. For performance and security reasons, it is not indicating the total number of users available in the system. The first call should be done without the cursor parameter. Subsequent calls should use the value of the next cursor returned in the previous call. Specific values of cursor are not guaranteed to be valid in the future and are not part of the API, so they should not be used as a key for caching or storing data. The order in which the users are returned is not defined. It is guaranteed that the same user will not be returned twice in the sequence of calls. For resiliency reason this endpoint never returns 404 code, even if called with a cursor parameter that was not returned in the previous call.

Available since Jira Data Center 11.0, and in 10.3 LTS.
Parameters
- client: Client
- Optionalparameters: { cursor?: number; maxResults?: number }
  - Optionalcursor?: number
    
    The position in the stream to continue iterating over all users.
  - OptionalmaxResults?: number
    
    The maximum number of users to return per page (defaults to 2000).
- Optionaloptions: RequestOptions
Returns Promise<
    {
        isLast?: boolean;
        maxResults?: number;
        nextCursor?: string;
        nextPage?: string;
        self?: string;
        values?: Record<string, any>[];
        [key: string]: unknown;
    },
>
- Defined in src/server/api/users.ts:612

Function getUserList

Parameters

`Optional`cursor?: number

`Optional`maxResults?: number

Returns Promise<
    {
        isLast?: boolean;
        maxResults?: number;
        nextCursor?: string;
        nextPage?: string;
        self?: string;
        values?: Record<string, any>[];
        [key: string]: unknown;
    },
>

Settings

Function getUserList

Parameters

Optionalcursor?: number

OptionalmaxResults?: number

Returns Promise< { isLast?: boolean; maxResults?: number; nextCursor?: string; nextPage?: string; self?: string; values?: Record<string, any>[]; [key: string]: unknown; },>

Settings

`Optional`cursor?: number

`Optional`maxResults?: number

Returns Promise<
{
isLast?: boolean;
maxResults?: number;
nextCursor?: string;
nextPage?: string;
self?: string;
values?: Record<string, any>[];
[key: string]: unknown;
},
>