Skip to main content
POST
Create a role group.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Body

application/json
name
string
required

Display name of the role group.

Example:

"Instance administrators"

desc
string

Operator-visible description of the role group.

Example:

"Users who can administer the full instance."

category
string

Optional presentation category for the role group.

Example:

"Administration"

metadata
object

Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

Example:
members
string[]

Optional user ids to attach as role-group members during creation.

Example:
roles
enum<string>[]

Optional role keys to assign during creation. Provide an empty array for a role group without roles.

Available options:
INSTANCE_ADMIN,
ME_KEY_MANAGER,
ME_MODIFY_ADVANCED,
ME_MODIFY_META,
USER_READ,
USER_WRITE,
USER_ADMIN,
RESOURCE_READ,
RESOURCE_WRITE,
RESOURCE_ADMIN,
FILE_READ,
FILE_ADMIN,
COMPONENT_READ,
COMPONENT_WRITE,
COMPONENT_ADMIN,
SECRET_READ,
SECRET_WRITE,
SECRET_ADMIN,
AUTOMATION_READ,
AUTOMATION_RUNNER,
AUTOMATION_ADMIN,
ENDPOINT_READ,
ENDPOINT_WRITE,
ENDPOINT_ADMIN,
ENDPOINT_INVOKE,
REALTIME_READ,
REALTIME_WRITE,
REALTIME_ADMIN,
REALTIME_CONNECT
Example:

Response

Created.

Last modified on September 5, 2026