Skip to main content
GET
/
rbac
/
groups
List all groups
curl --request GET \
  --url https://api.axiom.co/v2/rbac/groups \
  --header 'Authorization: Bearer <token>'
[
  {
    "name": "<string>",
    "id": "<string>",
    "description": "<string>",
    "isManaged": true,
    "members": [
      "<string>"
    ],
    "roles": [
      "<string>"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Authenticate using an API token or personal access token (PAT). Include the token as a Bearer token: Authorization: Bearer <token>. For more information, see Tokens.

Response

200 - application/json

A list of groups was successfully retrieved

​
name
string
required

Unique name identifier for the group

​
id
string
required

Unique identifier for the group

​
description
string

Detailed description of the group's purpose and scope

​
isManaged
boolean

Whether the group is managed by Axiom

​
members
string[]

List of user IDs that are assigned to this group

​
roles
string[]

List of role IDs that are assigned to this group