Role

Define roles and assign permissions.

Get organizations roles

get

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/roles

Get organizations roles by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

Current page number

Default: 1

sortstringOptional

Sort

Example: {"value":"createdAt"}

textstringOptional

Text

privilegesstringOptional

Privileges

Responses

200

OK

application/json

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/roles

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organizationId}/roles HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 1,
  "limit": 10,
  "page": 1,
  "totalPages": 1,
  "pagingCounter": 1,
  "hasPrevPage": true,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 1,
  "docs": []
}

Create a organization role

post

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/roles

Create a organization role by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

namestringOptional

Role name

Example: <name>

descriptionstringOptional

Role description

Example: <description>

privilegesstring[]Optional

Role privileges

Example: ["all:user:write"]

statusnumberOptional

Role status

Example: <status>

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/organizations/{organizationId}/roles

HTTPcURLJavaScriptPython

POST /api/v1/organizations/{organizationId}/roles HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "name": "<name>",
  "description": "<description>",
  "privileges": [
    [
      "all:user:write"
    ]
  ],
  "status": "<status>"
}

{
  "_id": "text",
  "organization": "text",
  "name": "text",
  "privileges": [
    "text"
  ],
  "status": 1,
  "createdAt": "2026-03-09T22:03:23.606Z",
  "updatedAt": "2026-03-09T22:03:23.606Z"
}

Get a organization role

get

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/roles/{roleId}

Get a organization role by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

roleIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

_idstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

namestring · min: 2 · max: 100Required

Role name

descriptionstringOptional

Role description

privilegesstring[]Optional

Role privileges, formatted as (:)

Example: ["project:read","project:write"]

createdAtstring · date-timeRead-onlyRequired

Date

updatedAtstring · date-timeRead-onlyRequired

Date

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/organizations/{organizationId}/roles/{roleId}

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organizationId}/roles/{roleId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "text",
  "name": "text",
  "description": "text",
  "organization": {
    "_id": "text",
    "name": "text",
    "slug": "text",
    "description": "text",
    "owner": "text",
    "isExecutive": false,
    "status": 0,
    "privileges": [
      "project:read",
      "project:write"
    ],
    "imageUrl": "text",
    "createdAt": "2026-03-09T22:03:23.606Z",
    "updatedAt": "2026-03-09T22:03:23.606Z"
  },
  "privileges": [
    "project:read",
    "project:write"
  ],
  "createdAt": "2026-03-09T22:03:23.606Z",
  "updatedAt": "2026-03-09T22:03:23.606Z"
}

Update a organization role

put

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/roles/{roleId}

Update a organization role by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

roleIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

namestringOptional

Role name

Example: <name>

descriptionstringOptional

Role description

Example: <description>

privilegesstring[]Optional

Role privileges

Example: ["all:user:write"]

statusnumberOptional

Role status

Example: <status>

Responses

200

OK

application/json

_idstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

namestring · min: 2 · max: 100Required

Role name

descriptionstringOptional

Role description

privilegesstring[]Optional

Role privileges, formatted as (:)

Example: ["project:read","project:write"]

createdAtstring · date-timeRead-onlyRequired

Date

updatedAtstring · date-timeRead-onlyRequired

Date

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

put

/organizations/{organizationId}/roles/{roleId}

HTTPcURLJavaScriptPython

PUT /api/v1/organizations/{organizationId}/roles/{roleId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "name": "<name>",
  "description": "<description>",
  "privileges": [
    [
      "all:user:write"
    ]
  ],
  "status": "<status>"
}

{
  "_id": "text",
  "name": "text",
  "description": "text",
  "organization": {
    "_id": "text",
    "name": "text",
    "slug": "text",
    "description": "text",
    "owner": "text",
    "isExecutive": false,
    "status": 0,
    "privileges": [
      "project:read",
      "project:write"
    ],
    "imageUrl": "text",
    "createdAt": "2026-03-09T22:03:23.606Z",
    "updatedAt": "2026-03-09T22:03:23.606Z"
  },
  "privileges": [
    "project:read",
    "project:write"
  ],
  "createdAt": "2026-03-09T22:03:23.606Z",
  "updatedAt": "2026-03-09T22:03:23.606Z"
}

Delete a organization role

delete

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/roles/{roleId}

Delete a organization role by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

roleIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Responses

204

No Content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/organizations/{organizationId}/roles/{roleId}

HTTPcURLJavaScriptPython

DELETE /api/v1/organizations/{organizationId}/roles/{roleId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content