RBAC

Role-Based Access Control operations

Get RBAC data

get

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

/rbac

Retrieve detailed RBAC data with all related information

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

roleIdstringOptional

Filter by role ID

roleNamestringOptional

Filter by role name

statusstringOptional

Filter by status

startDatestring · dateOptional

Start date filter

endDatestring · dateOptional

End date filter

excludeMemberIdstringOptional

Exclude specific member ID

pageSizestringOptional

Number of items per page

pageNumberstringOptional

Page number

sortBystringOptional

Sort field

sortOrderstring · enumOptional

Sort order

Possible values:

pointsnumberOptional

Filter by points

Responses

200

RBAC data retrieved successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

get

/rbac

HTTPcURLJavaScriptPython

GET /v1/rbac 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": [
    {
      "memberRole": {
        "memberRoleId": "123e4567-e89b-12d3-a456-426614174000",
        "memberId": "123e4567-e89b-12d3-a456-426614174000",
        "roleId": "123e4567-e89b-12d3-a456-426614174000",
        "memberName": "text",
        "roleName": "text",
        "status": "active",
        "startDateTime": "2025-12-16T02:57:35.290Z",
        "endDateTime": "2025-12-16T02:57:35.290Z",
        "firstApprovalBy": "123e4567-e89b-12d3-a456-426614174000",
        "secondApprovalBy": "123e4567-e89b-12d3-a456-426614174000",
        "firstApprovalDate": "2025-12-16T02:57:35.290Z",
        "secondApprovalDate": "2025-12-16T02:57:35.290Z",
        "firstApprovalStatus": true,
        "secondApprovalStatus": true,
        "approvalStatus": "pending",
        "approvingRoleId": "123e4567-e89b-12d3-a456-426614174000",
        "approvingRoleName": "text",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000",
        "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2025-12-16T02:57:35.290Z",
        "updatedAt": "2025-12-16T02:57:35.290Z"
      },
      "rolePermission": {
        "rolePermissionId": "123e4567-e89b-12d3-a456-426614174000",
        "roleId": "123e4567-e89b-12d3-a456-426614174000",
        "permissionId": "123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "startDateTime": "2025-12-16T02:57:35.290Z",
        "endDateTime": "2025-12-16T02:57:35.290Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000",
        "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2025-12-16T02:57:35.290Z",
        "updatedAt": "2025-12-16T02:57:35.290Z"
      }
    }
  ]
}

Get unique RBAC data

get

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

/rbac/unique

Retrieve basic RBAC data without detailed joins

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

roleIdstringOptional

Filter by role ID

roleNamestringOptional

Filter by role name

statusstringOptional

Filter by status

startDatestring · dateOptional

Start date filter

endDatestring · dateOptional

End date filter

excludeMemberIdstringOptional

Exclude specific member ID

pageSizestringOptional

Number of items per page

pageNumberstringOptional

Page number

sortBystringOptional

Sort field

sortOrderstring · enumOptional

Sort order

Possible values:

pointsnumberOptional

Filter by points

Responses

200

Unique RBAC data retrieved successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

get

/rbac/unique

HTTPcURLJavaScriptPython

GET /v1/rbac/unique 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": [
    {
      "roleId": "123e4567-e89b-12d3-a456-426614174000",
      "roleName": "text",
      "status": "text"
    }
  ]
}