Brein API

Role

Get all roles with pagination

GET

/api/v1/role

Retrieve a paginated list of roles based on query parameters

Get all roles with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
namestring
Name filter

Get all roles 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 role

POST

/api/v1/role

Create a new role with the provided data

Create a new role › Request Body

namestring · required
Name of the role
Example: parent

Create a new role › Responses

Role created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of the role
Example: parent

POST /api/v1/role

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

shell

Show example in

Request Body Example

{
  "name": "parent"
}

json

Example Responses

No example

json

application/json

Get all roles

GET

/api/v1/role/all

Retrieve a list of all roles without pagination

Get all roles › Responses

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of the role
Example: parent

Get role by ID

GET

/api/v1/role/{id}

Retrieve a specific role by its ID

Get role by ID › path Parameters

idnumber · min: 1 · required
Id

Get role by ID › Responses

Role detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of the role
Example: parent

Update a role

PUT

/api/v1/role/{id}

Update an existing role by its ID

Update a role › path Parameters

idnumber · min: 1 · required
Id

Update a role › Request Body

namestring
Name of the role
Example: parent

Update a role › Responses

Role updated

No data returned

PUT /api/v1/role/{id}

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

shell

Show example in

Request Body Example

{
  "name": "parent"
}

json

Example Responses

No example

plain

Delete a role

DELETE

/api/v1/role/{id}

Delete a role by its ID

Delete a role › path Parameters

idnumber · min: 1 · required
Id

Delete a role › Responses

Role deleted

No data returned

BulkProcess Role User

Brein API

Role

Get all roles with pagination

GET

/api/v1/role

Retrieve a paginated list of roles based on query parameters

Get all roles with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
namestring
Name filter

Get all roles 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 role

POST

/api/v1/role

Create a new role with the provided data

Create a new role › Request Body

namestring · required
Name of the role
Example: parent

Create a new role › Responses

Role created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of the role
Example: parent

POST /api/v1/role

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

shell

Show example in

Request Body Example

{
  "name": "parent"
}

json

Example Responses

No example

json

application/json

Get all roles

GET

/api/v1/role/all

Retrieve a list of all roles without pagination

Get all roles › Responses

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of the role
Example: parent

Get role by ID

GET

/api/v1/role/{id}

Retrieve a specific role by its ID

Get role by ID › path Parameters

idnumber · min: 1 · required
Id

Get role by ID › Responses

Role detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of the role
Example: parent

Update a role

PUT

/api/v1/role/{id}

Update an existing role by its ID

Update a role › path Parameters

idnumber · min: 1 · required
Id

Update a role › Request Body

namestring
Name of the role
Example: parent

Update a role › Responses

Role updated

No data returned

PUT /api/v1/role/{id}

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

shell

Show example in

Request Body Example

{
  "name": "parent"
}

json

Example Responses

No example

plain

Delete a role

DELETE

/api/v1/role/{id}

Delete a role by its ID

Delete a role › path Parameters

idnumber · min: 1 · required
Id

Delete a role › Responses

Role deleted

No data returned

BulkProcess Role User