Role Permissions

Role permission assignment and management

Get role permissions

get

https://api.example.com/v1https://staging-api.example.com/v1

/rbac/role-permission

Retrieve role permission assignments

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

rolePermissionIdstringOptional

Filter by role permission ID

roleIdstringOptional

Filter by role ID

permissionIdstringOptional

Filter by permission ID

statusstringOptional

Filter by status

startDatestring · dateOptional

Start date filter

endDatestring · dateOptional

End date filter

pageSizestringOptional

Number of items per page

pageNumberstringOptional

Page number

sortBystringOptional

Sort field

sortOrderstring · enumOptional

Sort order

Possible values:

Responses

200

Role permissions retrieved successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

get

/rbac/role-permission

HTTPcURLJavaScriptPython

GET /v1/rbac/role-permission HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "pagination": {
    "currentPage": 1,
    "totalPages": 10,
    "totalItems": 100,
    "itemsPerPage": 10,
    "hasNextPage": true,
    "hasPreviousPage": false
  },
  "data": [
    {
      "rolePermissionId": "123e4567-e89b-12d3-a456-426614174000",
      "roleId": "123e4567-e89b-12d3-a456-426614174000",
      "permissionId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "active",
      "startDateTime": "2025-12-16T02:58:38.036Z",
      "endDateTime": "2025-12-16T02:58:38.036Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-12-16T02:58:38.036Z",
      "updatedAt": "2025-12-16T02:58:38.036Z"
    }
  ]
}

Create role permission

post

https://api.example.com/v1https://staging-api.example.com/v1

/rbac/role-permission

Assign a permission to a role

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

roleIdstring · uuidRequired

Role ID

permissionIdstring · uuidRequired

Permission ID

statusstring · enumOptionalDefault: activePossible values:

startDateTimestring · date-timeOptional

endDateTimestring · date-timeOptional

Responses

201

Role permission created successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

post

/rbac/role-permission

HTTPcURLJavaScriptPython

POST /v1/rbac/role-permission HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "roleId": "123e4567-e89b-12d3-a456-426614174000",
  "permissionId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "active",
  "startDateTime": "2025-12-16T02:58:38.036Z",
  "endDateTime": "2025-12-16T02:58:38.036Z"
}

{
  "success": true,
  "message": "Role permission created successfully",
  "data": {
    "rolePermissionId": "123e4567-e89b-12d3-a456-426614174000",
    "roleId": "123e4567-e89b-12d3-a456-426614174000",
    "permissionId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "startDateTime": "2025-12-16T02:58:38.036Z",
    "endDateTime": "2025-12-16T02:58:38.036Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-12-16T02:58:38.036Z",
    "updatedAt": "2025-12-16T02:58:38.036Z"
  }
}

Get unique role permissions

get

https://api.example.com/v1https://staging-api.example.com/v1

/rbac/role-permission/unique

Retrieve unique role permission data

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

rolePermissionIdstringOptional

Filter by role permission ID

roleIdstringOptional

Filter by role ID

permissionIdstringOptional

Filter by permission ID

statusstringOptional

Filter by status

startDatestring · dateOptional

Start date filter

endDatestring · dateOptional

End date filter

pageSizestringOptional

Number of items per page

pageNumberstringOptional

Page number

sortBystringOptional

Sort field

sortOrderstring · enumOptional

Sort order

Possible values:

Responses

200

Unique role permissions retrieved successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

get

/rbac/role-permission/unique

HTTPcURLJavaScriptPython

GET /v1/rbac/role-permission/unique HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": [
    {
      "rolePermissionId": "123e4567-e89b-12d3-a456-426614174000",
      "roleId": "123e4567-e89b-12d3-a456-426614174000",
      "permissionId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "active",
      "startDateTime": "2025-12-16T02:58:38.036Z",
      "endDateTime": "2025-12-16T02:58:38.036Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-12-16T02:58:38.036Z",
      "updatedAt": "2025-12-16T02:58:38.036Z"
    }
  ]
}

Update role permission

put

https://api.example.com/v1https://staging-api.example.com/v1

/rbac/role-permission/{rolePermissionId}

Update role permission assignment

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

rolePermissionIdstring · uuidRequired

Role permission ID

Body

application/json

roleIdstring · uuidOptional

permissionIdstring · uuidOptional

statusstring · enumOptionalPossible values:

startDateTimestring · date-timeOptional

endDateTimestring · date-timeOptional

Responses

200

Role permission updated successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

put

/rbac/role-permission/{rolePermissionId}

HTTPcURLJavaScriptPython

PUT /v1/rbac/role-permission/{rolePermissionId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "roleId": "123e4567-e89b-12d3-a456-426614174000",
  "permissionId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "active",
  "startDateTime": "2025-12-16T02:58:38.036Z",
  "endDateTime": "2025-12-16T02:58:38.036Z"
}

{
  "success": true,
  "message": "Role permission updated successfully",
  "data": {
    "rolePermissionId": "123e4567-e89b-12d3-a456-426614174000",
    "roleId": "123e4567-e89b-12d3-a456-426614174000",
    "permissionId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "startDateTime": "2025-12-16T02:58:38.036Z",
    "endDateTime": "2025-12-16T02:58:38.036Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-12-16T02:58:38.036Z",
    "updatedAt": "2025-12-16T02:58:38.036Z"
  }
}

Get role permission by module

get

https://api.example.com/v1https://staging-api.example.com/v1

/rbac/role-permission/module/{module}

Get role permissions for a specific module when user is accessing it

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

modulestringRequired

Module name

Responses

200

Role permissions for module retrieved successfully

application/json

400

Validation error

application/json

401

Unauthorized access

application/json

500

Internal server error

application/json

get

/rbac/role-permission/module/{module}

HTTPcURLJavaScriptPython

GET /v1/rbac/role-permission/module/{module} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": {
    "rolePermissionId": "123e4567-e89b-12d3-a456-426614174000",
    "roleId": "123e4567-e89b-12d3-a456-426614174000",
    "permissionId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "startDateTime": "2025-12-16T02:58:38.036Z",
    "endDateTime": "2025-12-16T02:58:38.036Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-12-16T02:58:38.036Z",
    "updatedAt": "2025-12-16T02:58:38.036Z"
  }
}