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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Get all the available rights
Deck of Cards | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Card | | |||||||||||||||||
| ||||||||||||||||||
Name | Mandatory / Optional | Type | Description | |||||||||||||||
id | mandatory | string (guid) | Id of the right resource type | |||||||||||||||
resource | mandatory | string | The name of the right resource type | |||||||||||||||
rights | mandatory | object | Dictionary of the pairs of right id together with its name | |||||||||||||||
access | mandatory | JSON Array | Array of the strings represented access right. Can be combination of predefined rights "View", "Edit", "Admin" | |||||||||||||||
Name | Type | Default value | Description | |||||||||||||||
project | boolean | true | When query parameter "project=false" is defined, the API call will returns all right resource types except project right resource type. | |||||||||||||||
global | boolean | true | When query parameter "global=false" is defined, the API call will returns all right resource types except global right resource type. | |||||||||||||||
document | boolean | true | When query parameter "document=false" is defined, the API call will returns all right resource types except document right resource type. | |||||||||||||||
globalfreeattributes | boolean | true | When query parameter "globalfreeattributes=false" is defined, the API call will returns all right resource types except globalfreeattributes right resource type. | |||||||||||||||
layer | boolean | true | When query parameter "layer=false" is defined, the API call will returns all right resource types except layer right resource type. |
Card | ||
---|---|---|
| ||
GET |
Card | ||
---|---|---|
| ||
Get all the available rights returns array of right resource types with defined rights. |
Card | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 Ok
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[{ "id":"4e587ea1-5098-45cd-9655-15f90c16dc58", "resource":"Layer", "rights":{ "231222ba-7495-f438-cf38-629cf0482364":"building", "815ce797-da07-4372-8a59-609f7106ab09":"project" }, "access":["View", "Edit", "Admin" ] }, { "id":"9dae8bb5-77c1-47a6-a916-d4948583b0b9", "resource":"Global", "rights":{ "c64151c5-ecde-4e2c-ba53-d0390f480461":"projectdelete", "6bbc401b-7cd5-4684-a11d-e2448befb3c1":"projectcreate", "99bad6fc-0539-4848-84af-62b6df31eaa3":"allattributes", "3b3f10c1-93a6-4d15-a727-e38e2fb9b0b2":"alldocuments", "cc3416d3-c570-4dc6-aa84-72216d3f58da":"allmodels", "9351251b-9631-499e-8e23-68ffe70ef3b7":"allprojects" }, "access":["Edit" ] }, { "id":"500766a6-2525-45db-b9cd-b2a3d8092ba9", "resource":"GlobalFreeAttributes", "rights":{ "dd9b9e2c061a3842-f4af9b4d-576f4d19-4dda8651-9e122ab13d312f9373c42842":"general objectsfreeattribute", "92f8a36163b9bfad-5990db9f-0cb04bbe-b257a902-e13c85f0f7b17716c440a200":"mepattributetemplate", "0047e2ed04f5c272-33483dec-a97b4bce-93d285ae-a6817cc9cb8e6abb2e936ef8":"steel designprojectattributetemplate", "8095dfcf2a0e7bed-fbdf9fbf-331746bc-b873987a-a7cbccccb2067a6c5c638f98":"timber designfreeattributegroup", "f7819a2db886cab2-1498fcce-24684a77-b120ab2d-fdefedfccf0b09f704e363b7":"terrainteammembership", "903fe394-5e84-5c8d-2760-eeadad3baa35":"reinforcement"}, "44c2ff85-9691-6def-9583-56d8b776c846access":["finishView", "6719f657-ea4a-3016-1bda-0c56c7f113d4":"inventory",Edit" "52bbc329-dab3-a81c-b548-09c715786a81":"room", "4a4da391-b804-b20f-f49a-470bdc68be8f":"structural analysis", "7f27fd11-7992-8fb5-3541-9daa4f8196b2":"opening", "8ba5ec82-5b93-6192-55b0-b7790f4d0007":"door/window", "5c695e85-ea7c-7df4-9fb7-eca7aa1f69fd":"precast", "85d0b1a9-11bb-6de1-9cfd-54f85ee11da3":"bridge", "d726e8d2-12c6-641d-b19d-37511349dce1":"structural loads", "3517d0e2-9814-fc08-b3e7-59d453940efa":"connection" }, "access":["View", "Edit" ] }, { ] } ] |
Anchor | ||||
---|---|---|---|---|
|
Get details of the role
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
|
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 | |||||||||||||||
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 | ||||||||||||||||||
| ||||||||||||||||||
|
...
Get details of the role
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
Card |
|
...
|
Anchor | ||||
---|---|---|---|---|
|
Make a team member part of a project by assigning a role to him
...
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
|
Anchor | ||||
---|---|---|---|---|
|
Get the project members along with their respective roles
Deck of Cards | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
...
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
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. |
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 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"member": {
"id" : "bf5b2382-1d14-b8df-8454-947f83b45c25"
},
role: {
"id" : "f11d32e2-30b7-4f81-8a74-2165ecc00cf6"
} |
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "member }, { "id":"391fb0fc-43ec-464c-bd18-b5223b32bd14", "name":"Architekt" }, { "id":"33078aed-0473-4714-beb9-ab989959afdd", "name":"BuildingEditor" } ], "group": { "id": "9a63fe8e-4b80-4c21-af1b-4344f95df6bc", "role": "da3c04d7-b593-4017-b6c3-4c9eed7699bb" } }, { "member": { "id": "bf5b2382-1d14-b8df-8454-947f83b45c25", "email": "customer2@bimplus.net" "firstname" : "Some", "lastname" : "Customer", ... }, "role": { "id": "bf5b2382e11d32e2-1d1430b7-b8df4f81-84548a74-947f83b45c252165ecc00cf6", "emailname": "testuser@bimplus.net",Project_Viewer" "firstname" : "Test} "roles":[ { "id": "e11d32e2-30b7-4f81-8a74-2165ecc00cf6", "lastnamename" : "UserProject_Viewer", ... }, }], "rolegroup": { "id": "f11d32e29a63fe8e-30b74b80-4f814c21-8a74af1b-2165ecc00cf64344f95df6bc", "namerole": "Project_Editor" }da3c04d7-b593-4017-b6c3-4c9eed7699bb" } } ] |
Anchor | ||||
---|---|---|---|---|
|
...
Update the project
...
role of a team member
Deck of Cards | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Card | | |||||||||||||||||
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[
{
"member": {
"id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
"email": "testuser@bimplus.net",
"firstname" : "Test",
"lastname" : "User",
...
},
"role": {
"id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
"name": "Project_Editor"
},
{
"member": {
"id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
"email": "customer2@bimplus.net"
"firstname" : "Some",
"lastname" : "Customer",
...
},
"role": {
"id": "e11d32e2-30b7-4f81-8a74-2165ecc00cf6",
"name": "Project_Viewer"
}
}
] |
...
|
...
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 | ||||
---|---|---|---|---|
|
...