Get

[POST] .../v1/rolepermission/get

Returns information about access permissions role. Use this method to read permission values assigned to a specific RBAC role before showing or editing the role access matrix. The request body is required and must include role_id either as a filters; permission_id, group_id, value, role.name, permission.name and permission.group.name filters narrow the returned permission rows and search. The response returns paged RolePermission records with role metadata, translated permission and permission-group names for the current request language, next_offset and total. The caller must have role-permission read permission 19; missing body, invalid role_id, denied access, translation lookup errors, invalid sorting and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of records to return. The value is limited by server settings.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search string for role name, permission name and permission group name.
sort_orders Array of RolePermission_SortOrder Optional Output data sorting.

Filterable Fields

Field Type Description
group_id int Optional permission group ID filter.
permission.group.name string
permission.name string
permission_id int Optional permission ID filter.
role.name string
role_id int Role ID. Required by the endpoint.
value bool Required permission value. If this field is sent, only records with the specified value are returned.

Sortable Fields

Field
id
permission.group.name
permission.name
role.name
value

Request Example

{
  "filters": [
    {
      "Field": "role_id",
      "Operator": "Equal",
      "Value": "4"
    },
    {
      "Field": "group_id",
      "Operator": "Equal",
      "Value": "1"
    },
    {
      "Field": "value",
      "Operator": "Equal",
      "Value": "true"
    },
    {
      "Field": "permission.name",
      "Operator": "Like",
      "Value": "user"
    }
  ],
  "sort_orders": [
    {
      "column": "permission.group.name",
      "direction": "ASC"
    },
    {
      "column": "permission.name",
      "direction": "ASC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of RolePermission Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 37,
      "role": {
        "id": 4,
        "name": "Manager",
        "description": "Store manager role",
        "last_update": 1531805157
      },
      "permission": {
        "id": 19,
        "permission_group": {
          "id": 1,
          "parent_id": 0,
          "name": "RBAC",
          "order": 1,
          "last_update": 1529756282
        },
        "name": "View role permissions",
        "description": "Allows viewing role permission values",
        "default_value": true,
        "last_update": 1531244121
      },
      "value": true
    }
  ],
  "next_offset": 0,
  "total": 1
}