Roles

Role management operations

Get roles

get

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

/rbac/role

Retrieve role 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

memberIdstringOptional

Filter by member ID

memberNamestringOptional

Filter by member name

pageSizestringOptional

Number of items per page

pageNumberstringOptional

Page number

sortBystringOptional

Sort field

sortOrderstring · enumOptional

Sort order

Possible values:

approvalStatusstringOptional

Filter by approval status

searchMemberNamestringOptional

Search by member name

Responses

200

Roles retrieved successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

get

/rbac/role

HTTPcURLJavaScriptPython

GET /v1/rbac/role 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",
      "roleDescription": "text",
      "status": "active",
      "startDateTime": "2025-12-16T02:57:38.119Z",
      "endDateTime": "2025-12-16T02:57:38.119Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-12-16T02:57:38.119Z",
      "updatedAt": "2025-12-16T02:57:38.119Z"
    }
  ]
}

Create role

post

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

/rbac/role

Create a new role

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

roleNamestringRequired

Role name

roleDescriptionstringOptional

Role description

statusstring · enumOptionalDefault: activePossible values:

startDateTimestring · date-timeOptional

endDateTimestring · date-timeOptional

Responses

201

Role created successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

post

/rbac/role

HTTPcURLJavaScriptPython

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

{
  "roleName": "text",
  "roleDescription": "text",
  "status": "active",
  "startDateTime": "2025-12-16T02:57:38.119Z",
  "endDateTime": "2025-12-16T02:57:38.119Z"
}

{
  "success": true,
  "message": "Role created successfully",
  "data": {
    "roleId": "123e4567-e89b-12d3-a456-426614174000",
    "roleName": "text",
    "roleDescription": "text",
    "status": "active",
    "startDateTime": "2025-12-16T02:57:38.119Z",
    "endDateTime": "2025-12-16T02:57:38.119Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-12-16T02:57:38.119Z",
    "updatedAt": "2025-12-16T02:57:38.119Z"
  }
}

Get unique roles

get

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

/rbac/role/unique

Retrieve unique role data

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

memberIdstringOptional

Filter by member ID

memberNamestringOptional

Filter by member name

pageSizestringOptional

Number of items per page

pageNumberstringOptional

Page number

sortBystringOptional

Sort field

sortOrderstring · enumOptional

Sort order

Possible values:

approvalStatusstringOptional

Filter by approval status

searchMemberNamestringOptional

Search by member name

Responses

200

Unique roles retrieved successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

get

/rbac/role/unique

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "data": [
    {
      "roleId": "123e4567-e89b-12d3-a456-426614174000",
      "roleName": "text",
      "roleDescription": "text",
      "status": "active",
      "startDateTime": "2025-12-16T02:57:38.119Z",
      "endDateTime": "2025-12-16T02:57:38.119Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-12-16T02:57:38.119Z",
      "updatedAt": "2025-12-16T02:57:38.119Z"
    }
  ]
}

Update role

put

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

/rbac/role/{roleId}

Update role information

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

roleIdstring · uuidRequired

Role ID

Body

application/json

roleNamestringOptional

roleDescriptionstringOptional

statusstring · enumOptionalPossible values:

startDateTimestring · date-timeOptional

endDateTimestring · date-timeOptional

Responses

200

Role updated successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

put

/rbac/role/{roleId}

HTTPcURLJavaScriptPython

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

{
  "roleName": "text",
  "roleDescription": "text",
  "status": "active",
  "startDateTime": "2025-12-16T02:57:38.119Z",
  "endDateTime": "2025-12-16T02:57:38.119Z"
}

{
  "success": true,
  "message": "Role updated successfully",
  "data": {
    "roleId": "123e4567-e89b-12d3-a456-426614174000",
    "roleName": "text",
    "roleDescription": "text",
    "status": "active",
    "startDateTime": "2025-12-16T02:57:38.119Z",
    "endDateTime": "2025-12-16T02:57:38.119Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-12-16T02:57:38.119Z",
    "updatedAt": "2025-12-16T02:57:38.119Z"
  },
  "updateMemberRoleResult": {}
}