Permissions

The permissions is a collection with all the related permission objects attached to roles.

GET/v1/permissions

List permissions

This endpoint allows you to retrieve a paginated list of all your permissions.

Request

Optional query

Name
group
Type
string
Description
The group name for the permission.
Name
name
Type
string
Description
The name for the permission.

Response

Name
data
Type
array<object>
Description
Array of permission object
Name
data._id
Type
string
Description
Unique identifier for the permission.
Name
data.group
Type
string
Description
The group name for the permission.
Name
data.name
Type
string
Description
The name for the permission.
Name
pagination
Type
object
Description
Object of Pagination
Name
pagination.page
Type
number
Description
Page number.
Name
pagination.page_size
Type
number
Description
Number of total document per page.
Name
pagination.page_count
Type
number
Description
Total page count.
Name
pagination.total_document
Type
number
Description
Total filtered document.

Request

GET

/v1/permissions

const response = axios.get('/v1/permissions', {
  params: {
    filter: {
      group: 'role',
      name: 'role:create'
    }
  }
})

Response

{
  "permissions": [
    {
      "_id": "637b569149e0c02e1036c35a",
      "group": "role",
      "name": "role:create",
    },
    {
      "_id": "637d83d15d2be122007524bf",
      "group": "role",
      "name": "role:read",
    },
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "page_count": 1,
    "total_document": 2
  }
}