POST /_system/authentication-groups
Create a new authentication group
Create a new authentication group
| Key | Type | Example | Description |
|---|---|---|---|
| authorization required | string |
"Bearer access_token"
|
Access token
|
| Key | Type | Example | Description |
|---|---|---|---|
| name optional | string |
"example-string"
|
Group name
|
| description optional | string |
"example-string"
|
Group description
|
| permissions optional | array |
["example-string"]
|
Array of permission strings
|
| is_active optional | boolean |
true
|
Whether the group is active
|
{
"_meta": {
"guid": "example-string",
"entity": 42,
"created": 42,
"modified": 42,
"updated": 42
},
"name": "Administrators",
"description": "Full system access group",
"permissions": [
"view_audit_logs",
"manage_users",
"setting_edit_blueprints"
],
"is_active": true
}
{
"error": "INVALID_BODY",
"fields": [
"example-string"
]
}
| Status | Error Code | Description |
|---|---|---|
400 |
INVALID_BODY |
Validation error |
401 |
INVALID_ACCESS_TOKEN |
Authentication required or invalid token |
| Permission | Description |
|---|---|
Bearer token |
Access token required via Authorization header, x-authtoken, x-token, query param, or cookie |
authentication_groups_create |
Required scope: authentication_groups_create |
Back to Authentication Groups Return to the Authentication Groups category to view other endpoints All API Categories Browse all available API categories