REST API: Permissions
Generated from the daemon’s OpenAPI document. Conventions, sign-in, the CSRF header and the WebSocket are on API.
GET /api/groups/{groupId}/grants
Section titled “GET /api/groups/{groupId}/grants”Administrators only. Every grant of the group; its members have them all.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
groupId |
path | integer (int64) | yes |
Responses
- 200:
application/json: GroupGrants
Any failure answers with problem details (application/problem+json) and a stable code from the error reference.
PUT /api/groups/{groupId}/grants
Section titled “PUT /api/groups/{groupId}/grants”Administrators only. Replaces every grant of the group. Refused when no active administrator would be left.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
groupId |
path | integer (int64) | yes |
Request body: application/json: GrantsRequest
Responses
- 200:
application/json: GroupGrants
Any failure answers with problem details (application/problem+json) and a stable code from the error reference.
GET /api/permissions/catalog
Section titled “GET /api/permissions/catalog”Administrators only. The special rights, file protocols and apps a grant can name, in the order the editors show them.
Responses
- 200:
application/json: PermissionCatalog
Any failure answers with problem details (application/problem+json) and a stable code from the error reference.
GET /api/users/{userId}/grants
Section titled “GET /api/users/{userId}/grants”Administrators only. The user’s own grants, the grants its groups give it (the built-in group users included) and what it may do in the end.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
userId |
path | integer (int64) | yes |
Responses
- 200:
application/json: UserGrants
Any failure answers with problem details (application/problem+json) and a stable code from the error reference.
PUT /api/users/{userId}/grants
Section titled “PUT /api/users/{userId}/grants”Administrators only. Replaces every grant of the user. Refused when no active administrator would be left; applies to the user’s next request and is pushed to its desktop.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
userId |
path | integer (int64) | yes |
Request body: application/json: GrantsRequest
Responses
- 200:
application/json: UserGrants
Any failure answers with problem details (application/problem+json) and a stable code from the error reference.