Role Permission | Subrite

Role Permission

Endpoints for Role Permission

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/roles

Authentication: Bearer token (JWT)

Parameters

Query parameters4

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt", "id", "updatedAt"
orderDirectionstringOptional
Default: "desc"Allowed values: "asc", "desc"

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleRolePaginated

2 top-level fieldsSelect an object to expand

itemsarray of RoleRequired11 fields
items
- namestringRequired when parent is presentField path: items[].name

Example requestcurl

curl

curl https://api.subrite.no/api/v1/roles \
  --header 'Authorization: Bearer <token>'

Try it

Create a new role#

POST/api/v1/roles

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

SchemaCreateRoleDto

3 top-level fieldsSelect an object to expand

namestringRequired
maxLength: 100
isActivebooleanOptional
Default: true
sectionPermissionsarray of SectionPermissionRequired

GET/api/v1/roles/sections

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Examplearray of SectionPermission

4 top-level fields

sectionIdstringRequired when parent is present

GET/api/v1/roles/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleRoleResponse

Same fields as Create a new role (201).

DELETE/api/v1/roles/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

7 status codes

Responses 200

This response has no body.

Responses 400

PATCH/api/v1/roles/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateRoleDto

3 top-level fieldsSelect an object to expand

namestringOptional
maxLength: 100
isActiveboolean

tenantId

number

Schema ExampleRolePaginated

200 · application/json

{
  "items": [
    {
      "userRoles": [],
      "rolePermissions": [],
      "metaData": {}
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 17 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is presentField path: errors[].errorType

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses

5 status codes

Responses 201

Status201 400 401 403 500application/json

Schema ExampleRoleResponse

7 top-level fieldsSelect an object to expand

idnumberRequired
namestringRequired
userCountnumberRequired
isActivebooleanRequired
tenantIdnumberRequired
sectionPermissionsarray of SectionPermissionRequired4 fields
sectionPermissions
- sectionIdstringRequired when parent is presentField path: sectionPermissions[].sectionId
  maxLength: 255
- sectionNamestringField path: sectionPermissions[].sectionName
  maxLength: 255
- readPermissionbooleanRequired when parent is presentField path: sectionPermissions[].readPermission
- updatePermissionbooleanRequired when parent is presentField path: sectionPermissions[].updatePermission
updatedAtstring (date-time)Required

11 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleRoleResponse

201 · application/json

{
  "id": 0,
  "name": "string",
  "userCount": 0,
  "isActive": true,
  "tenantId": 0,
  "sectionPermissions": [
    {}
  ],
  "updatedAt": "2019-08-24T14:15:22Z"
}

Example · 11 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 500application/json

badRequest (incl. alreadyExists on name, unknownPermissionSection in errors[]), internalServerError (validation)

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "internalServerError"
messagestring
errorsarray of FieldError

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all roles of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status201 400 401 403 500application/json

internalServerError, permissionSectionNotConfigured

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "internalServerError", "permissionSectionNotConfigured"
messagestring
errorsarray of FieldErrorRequired

Example requestcurl

curl

curl https://api.subrite.no/api/v1/roles \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "isActive": true,
  "sectionPermissions": [
    {}
  ]
}'

Schema Examplearray of SectionPermission

200 · application/json

[
  {
    "sectionId": "string",
    "sectionName": "string",
    "readPermission": true,
    "updatePermission": true
  }
]

Example · 8 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all roles of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleRoleResponse

200 · application/json

{
  "id": 0,
  "name": "string",
  "userCount": 0,
  "isActive": true,
  "tenantId": 0,
  "sectionPermissions": [
    {}
  ],
  "updatedAt": "2019-08-24T14:15:22Z"
}

Example · 11 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get all roles of the tenant (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all roles of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

roleNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "roleNotFound"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "roleNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

application/json

Schema ExampleErrorResponse

Same fields as Get all roles of the tenant (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 409 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all roles of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 409 500application/json

roleNotFound

Schema ExampleErrorResponse

Same fields as Get a role by id with its section permissions (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "roleNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 409

Status200 400 401 403 404 409 500application/json

roleIsAssignedToUsers

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "roleIsAssignedToUsers"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

409 · application/json

{
  "messageCode": "roleIsAssignedToUsers",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleRoleResponse

Same fields as Create a new role (201).

Schema ExampleRoleResponse

200 · application/json

{
  "id": 0,
  "name": "string",
  "userCount": 0,
  "isActive": true,
  "tenantId": 0,
  "sectionPermissions": [
    {}
  ],
  "updatedAt": "2019-08-24T14:15:22Z"
}

Example · 11 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest (incl. alreadyExists on name, unknownPermissionSection in errors[]), internalServerError (validation)

Schema ExampleErrorResponse

Same fields as Create a new role (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all roles of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Responses 404

Status200 400 401 403 404 500application/json

roleNotFound

Schema ExampleErrorResponse

Same fields as Get a role by id with its section permissions (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "roleNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Responses 500

Status200 400 401 403 404 500application/json

internalServerError, permissionSectionNotConfigured

Schema ExampleErrorResponse

Same fields as Create a new role (500).

Schema ExampleErrorResponse

500 · application/json

{
  "messageCode": "internalServerError",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/roles/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "isActive": true,
  "sectionPermissions": [
    {}
  ]
}'

Schema ExampleErrorResponse

500 · application/json

{
  "messageCode": "internalServerError",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Get all roles of the tenant#

Parameters

Responses

Responses 200

Create a new role#

Request body

Get all sections with permissions#

Responses

Responses 200

Get a role by id with its section permissions#

Parameters

Responses

Responses 200

Delete role#

Parameters

Responses

Responses 200

Responses 400

Update a role#

Parameters

Request body

Get all roles of the tenant#

Parameters

Responses

Responses 200

Create a new role#

Request body

Get all sections with permissions#

Responses

Responses 200

Get a role by id with its section permissions#

Parameters

Responses

Responses 200

Delete role#

Parameters

Responses

Responses 200

Responses 400

Update a role#

Parameters

Request body

Responses 400

Responses 401

Responses 403

Responses 500

Responses

Responses 201

Responses 400

Responses 401

Responses 403

Responses 500

Responses 401

Responses 403

Responses 500

Responses 400

Responses 401

Responses 403

Responses 404

Responses 500

Responses 401

Responses 403

Responses 404

Responses 409

Responses 500

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 404

Responses 500