Permission Groups
Returns every permission group known by the authorization service.
Permission groups list
Unauthorized
Internal Server Error
GET /api/permission_groups HTTP/1.1
Accept: */*
{
"data": [
{
"id": 3,
"name": "data_dictionary"
}
]
}Creates a custom permission group.
Requires administrator access.
The group name must start with the configured custom prefix. Names without the prefix are rejected with 422.
Group names are unique: sending an existing name returns 422 with a "taken" error on name.
The response includes a Location header pointing at the newly created group.
Payload for creating a permission group.
The name must start with the configured custom prefix. Names without the prefix are rejected with 422.
Permission group created
Unauthorized
Forbidden
Unprocessable Entity
Internal Server Error
POST /api/permission_groups HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"permission_group": {
"name": "custom_my_group"
}
}{
"data": {
"id": 3,
"name": "data_dictionary"
}
}Returns the specified permission group.
Permission group ID.
Permission group detail
Unauthorized
Not found
Internal Server Error
GET /api/permission_groups/{id} HTTP/1.1
Accept: */*
{
"data": {
"id": 3,
"name": "data_dictionary"
}
}Updates the name of the specified permission group.
Requires administrator access.
The new name must start with the configured custom prefix. Names without the prefix are rejected with 422.
Permission group ID.
Payload for updating a permission group.
The new name must start with the configured custom prefix. Names without the prefix are rejected with 422.
Permission group updated
Unauthorized
Forbidden
Not found
Unprocessable Entity
Internal Server Error
PUT /api/permission_groups/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"permission_group": {
"name": "custom_new_name"
}
}{
"data": {
"id": 3,
"name": "data_dictionary"
}
}Permanently deletes the specified permission group.
Requires administrator access.
A permission group that still has permissions attached cannot be deleted: the request is rejected with 422.
Permission group ID.
Permission group deleted
No content
Unauthorized
Forbidden
Not found
Unprocessable Entity
Internal Server Error
DELETE /api/permission_groups/{id} HTTP/1.1
Accept: */*
No content
Updates the name of the specified permission group.
Requires administrator access.
The new name must start with the configured custom prefix. Names without the prefix are rejected with 422.
Permission group ID.
Payload for updating a permission group.
The new name must start with the configured custom prefix. Names without the prefix are rejected with 422.
Permission group updated
Unauthorized
Forbidden
Not found
Unprocessable Entity
Internal Server Error
PATCH /api/permission_groups/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"permission_group": {
"name": "custom_new_name"
}
}{
"data": {
"id": 3,
"name": "data_dictionary"
}
}Last updated