Brein API

Permission

Get all permissions with pagination

GET

/api/v1/permission

Retrieve a paginated list of permissions based on query parameters

Get all permissions with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
namestring
Name filter

Get all permissions with pagination › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

Create a new permission

POST

/api/v1/permission

Create a new permission with the provided data

Create a new permission › Request Body

namestring · required
Name of the permission
Example: Manage Users

Create a new permission › Responses

Permission created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of the permission
Example: Manage Users

POST /api/v1/permission

curl --request POST \
  --url /api/v1/permission \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Manage Users"
}
'

shell

Show example in

Request Body Example

{
  "name": "Manage Users"
}

json

Example Responses

No example

json

application/json

Get permission by ID

GET

/api/v1/permission/{id}

Retrieve a specific permission by its ID

Get permission by ID › path Parameters

idnumber · min: 1 · required
Id

Get permission by ID › Responses

Permission detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of the permission
Example: Manage Users

GET /api/v1/permission/{id}

curl --request GET \
  --url /api/v1/permission/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a permission

PUT

/api/v1/permission/{id}

Update an existing permission by its ID

Update a permission › path Parameters

idnumber · min: 1 · required
Id

Update a permission › Request Body

namestring
Name of the permission
Example: Manage Users

Update a permission › Responses

Permission updated

No data returned

PUT /api/v1/permission/{id}

curl --request PUT \
  --url /api/v1/permission/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Manage Users"
}
'

shell

Show example in

Request Body Example

{
  "name": "Manage Users"
}

json

Example Responses

No example

plain

Delete a permission

DELETE

/api/v1/permission/{id}

Delete a permission by its ID

Delete a permission › path Parameters

idnumber · min: 1 · required
Id

Delete a permission › Responses

Permission deleted

No data returned

DELETE /api/v1/permission/{id}

curl --request DELETE \
  --url /api/v1/permission/:id

shell

Show example in

Example Responses

No example

plain

Mobile Version Documents

Brein API

Permission

Get all permissions with pagination

GET

/api/v1/permission

Retrieve a paginated list of permissions based on query parameters

Get all permissions with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
namestring
Name filter

Get all permissions with pagination › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

Create a new permission

POST

/api/v1/permission

Create a new permission with the provided data

Create a new permission › Request Body

namestring · required
Name of the permission
Example: Manage Users

Create a new permission › Responses

Permission created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of the permission
Example: Manage Users

POST /api/v1/permission

curl --request POST \
  --url /api/v1/permission \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Manage Users"
}
'

shell

Show example in

Request Body Example

{
  "name": "Manage Users"
}

json

Example Responses

No example

json

application/json

Get permission by ID

GET

/api/v1/permission/{id}

Retrieve a specific permission by its ID

Get permission by ID › path Parameters

idnumber · min: 1 · required
Id

Get permission by ID › Responses

Permission detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of the permission
Example: Manage Users

GET /api/v1/permission/{id}

curl --request GET \
  --url /api/v1/permission/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a permission

PUT

/api/v1/permission/{id}

Update an existing permission by its ID

Update a permission › path Parameters

idnumber · min: 1 · required
Id

Update a permission › Request Body

namestring
Name of the permission
Example: Manage Users

Update a permission › Responses

Permission updated

No data returned

PUT /api/v1/permission/{id}

curl --request PUT \
  --url /api/v1/permission/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Manage Users"
}
'

shell

Show example in

Request Body Example

{
  "name": "Manage Users"
}

json

Example Responses

No example

plain

Delete a permission

DELETE

/api/v1/permission/{id}

Delete a permission by its ID

Delete a permission › path Parameters

idnumber · min: 1 · required
Id

Delete a permission › Responses

Permission deleted

No data returned

DELETE /api/v1/permission/{id}

curl --request DELETE \
  --url /api/v1/permission/:id

shell

Show example in

Example Responses

No example

plain

Mobile Version Documents