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

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

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

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

Was this page helpful?

Suggest editsRaise issue