Brein API

Role User

Get all role-user associations with pagination

GET

/api/v1/role-user

Retrieve a paginated list of role-user associations based on query parameters

Get all role-user associations with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
dummystring
Dummy filter

Get all role-user associations 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)

Assign role to user

POST

/api/v1/role-user

Assign a role to a user for the current school

Assign role to user › Request Body

userIdnumber · required
roleIdnumber · required

Assign role to user › Responses

RoleUser created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

POST /api/v1/role-user

curl --request POST \
  --url /api/v1/role-user \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": 0,
  "roleId": 0
}
'

shell

Show example in

Request Body Example

{
  "userId": 0,
  "roleId": 0
}

json

Example Responses

No example

json

application/json

Get role-user association by ID

GET

/api/v1/role-user/{id}

Retrieve a specific role-user association by its ID

Get role-user association by ID › path Parameters

idnumber · min: 1 · required
Id

Get role-user association by ID › Responses

RoleUser detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

GET /api/v1/role-user/{id}

curl --request GET \
  --url /api/v1/role-user/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a role-user association

PUT

/api/v1/role-user/{id}

Update an existing role-user association by its ID

Update a role-user association › path Parameters

idnumber · min: 1 · required
Id

Update a role-user association › Request Body

Update a role-user association › Responses

RoleUser updated

No data returned

PUT /api/v1/role-user/{id}

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

shell

Show example in

Request Body Example

{}

json

Example Responses

No example

plain

Delete a role-user association

DELETE

/api/v1/role-user/{id}

Delete a role-user association by its ID

Delete a role-user association › path Parameters

idnumber · min: 1 · required
Id

Delete a role-user association › Responses

RoleUser deleted

No data returned

Assign multiple roles to user

POST

/api/v1/role-user/bulk

Assign multiple roles to a user for the current school

Assign multiple roles to user › Request Body

userIdnumber · required
roleIdnumber · required

Assign multiple roles to user › Responses

RoleUser created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

POST /api/v1/role-user/bulk

curl --request POST \
  --url /api/v1/role-user/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "userId": 0,
    "roleId": 0
  }
]
'

shell

Show example in

Request Body Example

[
  {
    "userId": 0,
    "roleId": 0
  }
]

json

Example Responses

No example

json

application/json

Remove role from user

DELETE

/api/v1/role-user/role/{roleId}/user/{userId}

Remove a specific role from a user. Only SCHOOL_ADMINISTRATOR and SUPER_ADMIN can perform this action

Remove role from user › path Parameters

roleIdnumber · required
userIdnumber · required

Remove role from user › Responses

Role of User deleted

No data returned

DELETE /api/v1/role-user/role/{roleId}/user/{userId}

curl --request DELETE \
  --url /api/v1/role-user/role/:roleId/user/:userId

shell

Show example in

Example Responses

No example

plain

Role Parent

Brein API

Role User

Get all role-user associations with pagination

GET

/api/v1/role-user

Retrieve a paginated list of role-user associations based on query parameters

Get all role-user associations with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
dummystring
Dummy filter

Get all role-user associations 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)

Assign role to user

POST

/api/v1/role-user

Assign a role to a user for the current school

Assign role to user › Request Body

userIdnumber · required
roleIdnumber · required

Assign role to user › Responses

RoleUser created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

POST /api/v1/role-user

curl --request POST \
  --url /api/v1/role-user \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": 0,
  "roleId": 0
}
'

shell

Show example in

Request Body Example

{
  "userId": 0,
  "roleId": 0
}

json

Example Responses

No example

json

application/json

Get role-user association by ID

GET

/api/v1/role-user/{id}

Retrieve a specific role-user association by its ID

Get role-user association by ID › path Parameters

idnumber · min: 1 · required
Id

Get role-user association by ID › Responses

RoleUser detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

GET /api/v1/role-user/{id}

curl --request GET \
  --url /api/v1/role-user/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a role-user association

PUT

/api/v1/role-user/{id}

Update an existing role-user association by its ID

Update a role-user association › path Parameters

idnumber · min: 1 · required
Id

Update a role-user association › Request Body

Update a role-user association › Responses

RoleUser updated

No data returned

PUT /api/v1/role-user/{id}

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

shell

Show example in

Request Body Example

{}

json

Example Responses

No example

plain

Delete a role-user association

DELETE

/api/v1/role-user/{id}

Delete a role-user association by its ID

Delete a role-user association › path Parameters

idnumber · min: 1 · required
Id

Delete a role-user association › Responses

RoleUser deleted

No data returned

Assign multiple roles to user

POST

/api/v1/role-user/bulk

Assign multiple roles to a user for the current school

Assign multiple roles to user › Request Body

userIdnumber · required
roleIdnumber · required

Assign multiple roles to user › Responses

RoleUser created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

POST /api/v1/role-user/bulk

curl --request POST \
  --url /api/v1/role-user/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "userId": 0,
    "roleId": 0
  }
]
'

shell

Show example in

Request Body Example

[
  {
    "userId": 0,
    "roleId": 0
  }
]

json

Example Responses

No example

json

application/json

Remove role from user

DELETE

/api/v1/role-user/role/{roleId}/user/{userId}

Remove a specific role from a user. Only SCHOOL_ADMINISTRATOR and SUPER_ADMIN can perform this action

Remove role from user › path Parameters

roleIdnumber · required
userIdnumber · required

Remove role from user › Responses

Role of User deleted

No data returned

DELETE /api/v1/role-user/role/{roleId}/user/{userId}

curl --request DELETE \
  --url /api/v1/role-user/role/:roleId/user/:userId

shell

Show example in

Example Responses

No example

plain

Role Parent