Sofar logo
Sofar logo
Api
Delete a manages relation DELETECollect manages relations (replaced by POST /v1/role/{parentRoleId}/manages/query) GETCollect manages relations POSTCreate or update a manages relation PUTUpdate an existing manages relation PUT
Manages

Create or update a manages relation PUT

Create a manages relation (or update the existing one) between two roles<br><br> When a valid childRolePassword query parameter is specified, the call can be executed when the user is a member of an autorizing role which has direct or indirect roleManagement rights for the parent role of the newly created (or updated) manages relation.<br><br> When no childRolePassword query parameter is provided, a user can only execute this action if he is a member of an autorizing role which has: <ul> <li> direct or indirect roleManagement rights for the parent role of the newly created (or updated) manages relation </li> <li> *indirect* roleManagement rights for the child role of the newly created (or updated) manages relation </li> </ul>

Delete a member relation DELETE

A user can only execute this action if he is a member of an authorizing role which satisfies one of the following conditions: <ul> <li> The authorizing role has *direct or indirect* userManagement rights for the role to which a member is deleted </li> <li> The authorizing role has *indirect* roleManagement rights for the role to which a member is deleted </li> <li> The authorizing role is the role from which a member is removed, and the removed member is the user itself </li> </ul>

PUT
/v1/role/{parentRoleId}/manages/{managesId}

Update an existing manages relation. A user can only execute this action if he is a member of an autorizing role which has (direct or indirect) roleManagement rights for the parent role of the manages relation

Authorization

accessBearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

parentRoleId*integer
Range0 <= value
managesId*integer
Range0 <= value

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://api.eniris.be/v1/role/0/manages/0" \  -H "Content-Type: application/json" \  -d '{    "roleManagement": true,    "userManagement": true,    "viewManagement": true,    "deviceManagement": true,    "reportManagement": true,    "alarmManagement": true  }'
roleManagement*boolean
userManagement*boolean
viewManagement*boolean
deviceManagement*boolean
reportManagement*boolean
alarmManagement*boolean

Indicates that the parent role has the right to attach the child role and its decendants to any other role.

Indicates that the parent role has the right to manage member relations for the child role and its decendants.

Indicates that the parent role has the right to manage views relations for the child role and its decendants.

Indicates that the parent role has the right to manage monitors relations for the child role and its decendants.

Indicates that the parent role has the right to manage "views report relations" for the child role and its decendants

Indicates that the parent role has the right to manage "alarm relations" for the child role and its decendants

application/json

application/json

application/json

In the value field below, fill in the access token. It has a 10 minutes validity period. A valid token can be obtained via the /accesstoken endpoint (call), AFTER authorization with refreshBearerAuth and the refresh token.

Id of the parent role of the manages relation

Id of the updated manages relation

{
  "manages": {
    "id": 0,
    "parentRoleId": 0,
    "childRoleId": 0,
    "roleManagement": true,
    "userManagement": true,
    "viewManagement": true,
    "deviceManagement": true,
    "reportManagement": true,
    "alarmManagement": true
  }
}
{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Missing or misformatted query parameter or body"
}
{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Failed to verify token"
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "User does not have sufficient rights"
}