Skip to content

Role object fields

Example of JSON-formatted role instance:

{
    "role":
    {
        "role_id": "34c88e5c-9201-11e5-92fa-e03f497dbdff",
        "name": "Administrator",
        "access_level": "system",
        "tenant_id": "34c7f1f6-9201-11e5-a739-e03f497dbdff"
        "permissions":
        {
            "roles": ["view"],
            "users": ["view", "edit", "delete"],
            "groups": ["view"],
            "calls": ["view", "live_monitor", "categorize", "playback", "add_notes"],
            "call_categories": ["view", "edit", "delete"],
            "call_notes": ["view", "pin"]
        }
    }
}
Field Type Description
name string Role name.
role_id UUID Unique ID of role assigned by MiaRec when role is created.
tenant_id UUID ID of parent tenant object. This field is available only when multi-tenancy is enabled in MiaRec.
access_level string

Access level setting specifies which resources are accessible by user of such role.

Supported values:

  • root - User with such role has unrestricted access to the system.
  • system - User with such role has access to all resources on the system (users, groups, calls), but the operations are restricted by permissions. One exception from this rule is when multi-tenancy is enabled and user belongs to particular tenant account. In this case access is limited to tenant resources only.
  • managed_groups - User with such role has access only to resources within the managed groups. A list of managed groups is configured in user's profile. The group manager may see only users and their calls, for which he/she is a manager. Other users/calls are not visible to group manager.
  • user - User with such role has access only to own call recordings.
permissions dictionary

Permissions setting specifies what operations are permitted on the accessible resources. These operations include view, edit, delete, playback etc.

Format:

RESOURCE_NAME: [PERMISSION_1, PERMISSION_2, ...]

Example:

"permissions": {"groups": ["view"],"users": ["view", "edit", "delete"],}

In above example, user has read-only (view) access to groups recources and full access rights (view, edit and delete) to users resources.

MiaRec supports very granular configuration of role permissions. A list of resources and supported permissions may be extended in each new software release. We recommend to use web portal to create a reference role with all checkboxes checked and then retrieve such role via REST API. In the response message you will be able to see a list of all supported resources and permissions on your version.