Create group

POST/v2/rbac/groups

Creates a group whose members get the group's roles. Requires an Enterprise plan or the RBAC add-on. The name must be unique, every role ID must exist, and you can't add yourself as a member.

Body

Defines a group of users for organizational purposes

application/json

Property	Type	Description
`description`	`string`	Detailed description of the group's purpose and scope
`isManaged`	`boolean`	Whether the group is synced from your identity provider. You can't delete a managed group or change its members.
`members`	`string[]`	List of user IDs that are assigned to this group
`name`	`string`Required	Unique name identifier for the group
`roles`	`string[]`	IDs of the roles assigned to the group. Use a custom role ID or a built-in role ID: `axiom-owner`, `axiom-admin`, `axiom-user`, `axiom-read-only`, or `axiom-none`.

Request

curl -X POST 'https://api.axiom.co/v2/rbac/groups' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"description":"string","isManaged":true,"members":["string"],"name":"string","roles":["string"]}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token RequiredRequest body application/json

Response

200The created group.

application/json

400Bad Request

403Forbidden

Property	Type	Description
`description`	`string`	Detailed description of the group's purpose and scope
`isManaged`	`boolean`	Whether the group is synced from your identity provider. You can't delete a managed group or change its members.
`members`	`string[]`	List of user IDs that are assigned to this group
`name`	`string`Required	Unique name identifier for the group
`roles`	`string[]`	IDs of the roles assigned to the group. Use a custom role ID or a built-in role ID: `axiom-owner`, `axiom-admin`, `axiom-user`, `axiom-read-only`, or `axiom-none`.
`id`	`string`Required	Unique identifier for the group