Rights and Roles Service
Rights and Roles
- Get all the available roles
- Get all the available rights
Create a new role - Get details of the role
- Update the role
- Delete the role
- Get all project's roles assigned by right and roles template
- Make a team member part of a project by assigning a role to him
- Get the project members along with their respective roles
- Update the project role of a team member
- Remove the user from the project
Rights and Roles Service
Rights and Roles
Anchor | ||||
---|---|---|---|---|
|
...
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Get all the available rights
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Get
...
details of the
...
role
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Card |
|
Anchor | ||||
---|---|---|---|---|
|
Get all project's roles assigned by right and roles template
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Create a new role
Deck of Cards | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Card | | |||||||||||||||||
| ||||||||||||||||||
Name | Mandatory / Optional | Type | Description | |||||||||||||||
id | optional | string (guid) | Id of the role | |||||||||||||||
name | mandatory | string | The name of the role | |||||||||||||||
parent | optional | string (guid) | The Id of the parent role | |||||||||||||||
customRole | optional | boolean | When this flag is true the role is custom role otherwise will role is 'built in' role | |||||||||||||||
resources | optional | JSON Array | Array of the right resource type definition objects for which the role is valid | |||||||||||||||
projectRightsRolesTemplate | mandatory | JSON object | The object contains id of rights and roles template guid. | |||||||||||||||
Name | Mandatory / Optional | Type | Description | |||||||||||||||
id | optional | string(Guid) | Id of the right resource type | |||||||||||||||
resource | mandatory | string | Describe kind of right resource type e.g. Global" or "Layer", etc. | |||||||||||||||
rights | mandatory | JSON Array | Array of the strings with right names e.g.: "FreeAttributeView", "RoomModel" | |||||||||||||||
rightsAccess | mandatory | JSON Array | Array of the objects with properties id, name, access :
|
Card | ||
---|---|---|
| ||
POST |
Card | ||
---|---|---|
| ||
Creates a new role with defined properties and resources to be valid for. |
Card | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
| ||||||||||||||||||
Card | ||||||||||||||||||
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"id": "94a60a79-7c81-454b-8158-ffdb9a2bf4d6",
"name":"Test",
"customRole":true,
"resources":[{
"id":"4e587ea1-5098-45cd-9655-15f90c16dc58",
"resource":"Layer",
"rights":["Room"
],
"rightsAccess":[{
"id":"52bbc329-dab3-a81c-b548-09c715786a81",
"name":"RoomModel",
"access":"Edit"
}
]
}
],
"projectRightsRolesTemplate":{
"id":"894072db-e1cb-48f1-a672-999356d66311",
"name":"CustomProjectRightsRolesTemplate",
"description":"Custom template for rights and roles"
}
} |
...
Get details of the role
...
id | bimGetRoleDetails |
---|
Card | ||||
---|---|---|---|---|
| ||||
Resource: <team_slug>/roles/<role_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/roles/<role_id> Example: https://api-stage.bimplus.net/v2/bimplus/roles/94a60a79-7c81-454b-8158-ffdb9a2bf4d6 |
Card | ||
---|---|---|
| ||
GET |
Card | ||
---|---|---|
| ||
Get details of a specified role. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"id" : "94a60a79-7c81-454b-8158-ffdb9a2bf4d6",
"name":"Test",
"customRole":true,
"resources":[{
"id":"4e587ea1-5098-45cd-9655-15f90c16dc58",
"resource":"Layer",
"rights":["Room"
],
"rightsAccess":[{
"id":"52bbc329-dab3-a81c-b548-09c715786a81",
"name":"RoomModel",
"access":"Edit"
}
]
}
],
"projectRightsRolesTemplate":{
"id":"894072db-e1cb-48f1-a672-999356d66311",
"name":"CustomProjectRightsRolesTemplate",
"description":"Custom template for rights and roles"
}
}
|
...
Update the role
...
id | bimUpdateTheRole |
---|
...
default | true |
---|---|
label | URL / Resource / JSON Structure |
Resource: <team_slug>/roles/<role_id>
URL: https://api-stage.bimplus.net/v2/<team_slug>/roles/<role_id>
Example: https://api-stage.bimplus.net/v2/bimplus/roles/94a60a79-7c81-454b-8158-ffdb9a2bf4d6
Json structure : See above in Create a new role section.
Card | ||
---|---|---|
| ||
PUT |
Card | ||
---|---|---|
| ||
Update the role. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"name":"Test",
"customRole":true,
"resources":[{
"id":"4e587ea1-5098-45cd-9655-15f90c16dc58",
"resource":"Layer",
"rights":["Room"
],
"rightsAccess":[{
"id":"52bbc329-dab3-a81c-b548-09c715786a81",
"name":"RoomModel",
"access":"Edit"
}
]
}
],
"projectRightsRolesTemplate":{
"id":"894072db-e1cb-48f1-a672-999356d66311"
}
} |
|
Anchor | ||||
---|---|---|---|---|
|
Make a team member part of a project by assigning a role to him
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||
---|---|---|
| ||
{
"id" : "94a60a79-7c81-454b-8158-ffdb9a2bf4d6",
"name":"Test",
"customRole":true,
"resources":[{
"id":"4e587ea1-5098-45cd-9655-15f90c16dc58",
"resource":"Layer",
"rights":["Room"
],
"rightsAccess":[{
"id":"52bbc329-dab3-a81c-b548-09c715786a81",
"name":"RoomModel",
"access":"Edit"
}
]
}
],
"projectRightsRolesTemplate":{
"id":"894072db-e1cb-48f1-a672-999356d66311",
"name":"CustomProjectRightsRolesTemplate",
"description":"Custom template for rights and roles"
}
} |
...
Delete the role
...
id | bimDeleteTheRole |
---|
Card | ||||
---|---|---|---|---|
| ||||
Resource: <team_slug>/roles/<role_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/roles/<role_id> Example: https://api-stage.bimplus.net/v2/bimplus/roles/213becc0-ad48-4cd0-aef2-b922b21bbfd7 |
Card | ||
---|---|---|
| ||
DELETE |
Card | ||
---|---|---|
| ||
Deletes a specified role. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
Get all project's roles assigned by right and roles template
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
Card |
|
...
|
...
Make a team member part of a project by assigning a role to him
Deck of Cards | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Card | | |||||||||||||||||
| ||||||||||||||||||
Name | Mandatory / Optional | Type | Description | |||||||||||||||
member | mandatory | object | The member who will be assigned a role to the project. | |||||||||||||||
role | mandatory | object | The project role which will be assigned to the team member. | |||||||||||||||
roles | mandatory | JSON Array | Array of role objects, each object must have defined role id. |
Card | ||
---|---|---|
| ||
POST |
Card | ||
---|---|---|
| ||
Assign a project role to an existing member of a team. Only the user with "Account Owner" or "Project Owner" role can use this API call. |
Card | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Get the project members along with their respective roles
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Get the project members along with their respective roles
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
Card |
|
Anchor | ||||
---|---|---|---|---|
|
Update the project role of a team member
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
|
...
Update the project role of a team member
Deck of Cards | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Card | | |||||||||||||||||
| ||||||||||||||||||
Name | Mandatory / Optional | Type | Description | |||||||||||||||
member | mandatory | object | The member who will be assigned a role to the project | |||||||||||||||
id | mandatory | string (guid) | Id of the user | |||||||||||||||
role | mandatory | object | The project role which will be assigned to the team member | |||||||||||||||
id | mandatory | string (guid) | Id of the role |
Card | ||
---|---|---|
| ||
PUT |
Card | ||
---|---|---|
| ||
Update the project role of a team member. Only the user with "Account Owner" or "Project Owner" role can use this API call. |
Card | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
| ||||||||||||||||||
Card | ||||||||||||||||||
| ||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
...