Create group

Creates a new group in the organization.

POST /rbac/groups

Create group

cURL

curl --request POST \
  --url https://api.axiom.co/v2/rbac/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "members": [
    "<string>"
  ],
  "roles": [
    "<string>"
  ]
}
'

200

{
  "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.

Body

application/json

The group configuration

Defines a group of users for organizational purposes

name · string · required

Unique name identifier for the group

description · string

Detailed description of the group's purpose and scope

members · string[]

List of user IDs that are assigned to this group

roles · string[]

List of role IDs that are assigned to this group

Response

200 - application/json

The group was successfully created

Extends the base Group type to include a unique identifier

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 · read-only

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