Get a List of Groups

Description: Returns the list of all groups.

Since: 7.49.3, role filtering parameters since 7.117.1

Authorization: Requires authentication using Access Tokens, either as admin or using a scoped token with the system:identities:r scope.

Usage: GET /access/api/v2/groups

Produces: application/json

Sample usage:

curl -X GET \
'http://localhost:8081/access/api/v2/groups?limit=100&resourceName=testrepo&role=project_admin&resourceType=repo&projectKey=testproject1' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'

Sample Response:

{
  "cursor": "string",
  "groups": [
    {
      "group_name": "string",
      "uri": "string"
    }
  ]
}

Query parameters:

String	Type	Mandatory	Description
`limit`	Number	Optional	Allows you to control the number of results. The valid value is a minimum of 1, and the default value is 1,000. For example, to set the limit to 5000, use the following API: `/access/api/v2/groups?limit=5000`
`groupName`	String	Optional	Contains the group name.
`cursor`	String	Optional	Divides the list of results and shows those that fall after the cursor for pagination purposes.
`role`	String	Mandatory if filtering by repository role	Supported from Artifactory version 7.117.x. Filters results by role.
`resourceType`	String	Mandatory if filtering by repository role	Supported from Artifactory version 7.117.x. Filter results by resource type.
`resourceName`	String	Mandatory if filtering by repository role	Supported from Artifactory version 7.117.x. Filter results by repository name.
`projectKey`	String	Optional	Filter results by project key. This parameter is used to further refine the search within a specific project context: if provided, the JFrog Platform will first check if the `projectKey` matches the project key of the resource. If there is no match, it will check if the resource is shared with the specified project.

Response Codes:

201: Successful
400: Invalid input, object invalid
401: Invalid credentials
403: Insufficient permissions