Get User List

get

https://{jfrog_url}/access/api/v2/users

Returns the list of users.

Security: Requires admin privileges, or a scoped token with system:identities:r.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Strings

You can use the following optional query strings in the Get User List API.

String	Description
`status`	An enum string with the possible values: invited, enabled, disabled, locked
`limit`	A number, minimum 1. The default value is 1000.
`username`	A string that contains the username.
`onlyAdmins`	Boolean to indicate whether the user is an admin.
`cursor`	A string. Divides the list of results and shows those that fall after the cursor for pagination purposes.

Query Params

status

string

enum

Filter users by status

Allowed:

limit

integer

≥ 1

Defaults to 1000

Number of results to return (minimum 1, default 1000)

username

string

Filter by username (contains)

onlyAdmins

boolean

Filter to only admin users. Cannot be used with resourceName. Available from Artifactory 7.117.x.

cursor

string

Pagination cursor - shows results after this cursor

role

string

Filter users by role. When filtering by role, onlyAdmins and username parameters are ignored. Available from Artifactory 7.117.x.

resourceType

string

Filter by resource type. Required when filtering by repository role. Available from Artifactory 7.117.x.

resourceName

string

Filter by repository name. Cannot be used with onlyAdmins. Available from Artifactory 7.117.x.

projectKey

string

Filter by project key. Refines search within a specific project context.

descendingOrder

boolean

Sort results in descending order

Responses

400

Bad Request - Invalid input, object invalid

401

Bad Credentials - Invalid credentials

403

Permission Denied - Insufficient permissions

Query Strings

200Success