List groups

GET

/api/security/groups

const url = 'https://example.com/api/security/groups';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/security/groups \
  --header 'Authorization: Bearer <token>'

Retrieves all groups in the system

Authorizations

bearerAuth

Responses

200

Groups retrieved successfully

application/json

object

count

Total number of groups

number

items

required

Array of groups

Array<object>

object

required

Group ID

string

searchId

required

Searchable ID

string

name

required

Group name

string

groups

Nested group memberships

Array<string>

default:

users

Users in this group

Array<string>

default:

roles

Roles assigned to group

Array<string>

default:

repos

Repository permissions

Array<object>

default:

object

CACHE_ROOT

required

Repository namespace

string

required

Repository ID

string

permission

required

Permission level (view, write, admin)

string

type

Entity type

string

default: group

description

Group description

string

Example

{
  "items": [
    {
      "id": "content-team",
      "searchId": "content-team",
      "name": "Content Team",
      "groups": [],
      "users": [],
      "roles": [],
      "repos": [],
      "type": "group"
    }
  ]
}