User Role
User role is a group of permissions that are assigned to the user. Permissions are assigned to individual operations on objects.
There are multiple pre-defined roles:
| Role | Description |
|---|---|
| viewer | Read-only user, cannot change any API object. May be useful for automated data export or auditor access. |
| annotator | In addition to permissions of annotator_limited the user is also allowed to import a document. |
| admin | User can modify API objects to set-up organization (e.g. workspaces queues schemas |
| manager | In addition to permissions of annotator the user is also allowed to access usage-reports |
| annotator_limited | User that is allowed to change annotation and its datapoints. Note: this role is under active development and should not be used in production environment. |
| annotator_embedded | This role is specifically designed to be used with embedded mode User can modify annotation and its datapoints, also has read-only permissions for objects needed for interaction on embedded validation screen. |
| organization_group_admin | In addition to permissions of admin the user can manage memberships among organizations within her organization group Talk with a Rossum representative about enabling this feature. |
| approver | In addition to permission of viewer the user can also approve/reject annotations. This may be combined with other roles. Talk with a Rossum representative about enabling this feature. For more info see workflows |
Please note that id may be different between organizations, use names to identify groups properly.
User can only access annotations from queues it is assigned to, except for admin and organization_group_admin roles that can access any queue.
Permissions assigned to the role cannot be changed through the API.
User role
ID of the user role (may differ between different organizations)
URL of the user role
Name of the user role
List user roles
Retrieve all user role objects.
curl -X GET "https://example.rossum.app/api/v1/groups"{
"pagination": {
"next": null,
"previous": null
},
"results": [
{
"id": 3,
"url": "https://example.rossum.app/api/v1/groups/3",
"name": "admin"
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Retrieve user role
Get a user role object.
curl -X GET "https://example.rossum.app/api/v1/groups/0"{
"id": 3,
"url": "https://example.rossum.app/api/v1/groups/3",
"name": "admin"
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
ID of the user role (may differ between different organizations)
URL of the user role
Name of the user role
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error