Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Deck of Cards
idbimGetAllRoles
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: <team_slug>/roles 

URLhttps://api.bimplus.net/v2/<team_slug>/roles

Examplehttps://api.bimplus.net/v2/best-company/roles

Card
labelDescription

 Get all the available. Right now, we support only project based roles.

Here is the definition of Bimplus Rights & Roles.

| | Account \\
Owner | Project \\
Admin | Project \\
Editor | Project \\
Viewer | Model \\
Admin | Model \\
Editor | Model \\
Viewer |
| Create Project | x | x | | | | | |
| Admin Project (eg. invite) | x | x | | | | | |
| Edit Project | x | x | x | | | | |
| Delete Project | x | x | | | | | |
| View Project | x | x | x | x | x | x | x |
| | | | | | | | |
| View all Models | x | x | x | x | | | |
| Create Model | x | x | x | | | | |
| Admin Model (eg. invite) | x | x | | | | | |
| Assign User to Model | x | x | x | | x | | |
| Edit Model | x | x | x | | x | x | |
| Import Data | x | x | x | | x | x | |
| Delete Model | x | x | x | | x | | |
| View Model | x | x | x | x | x | x | x |

Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 Ok
Code Block
borderColorRed
titleJSON
langxml
[
    {
        "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
        "name": "Project_Editor",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_Edit",
                    "Project_View",
                    "Model_ViewAll"
                ]
            }
        ]
    },
    {
        "id": "2baca0e4-2eee-4f7c-bc56-22ed54a1859c",
        "name": "Account_Owner",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightGlobal",
                "rights": [
                    "AllProjects",
                    "AllModels",
                    "Project_Create"
                ]
            }
        ]
    },
    {
        "id": "a298b28d-9711-4a76-9a7d-910cbf144ee5",
        "name": "Project_Admin",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_Admin",
                    "Project_Edit",
                    "Project_Delete",
                    "Project_View",
                    "Model_ViewAll",
                    "Model_Create"
                ]
            }
        ]
    },
    {
        "id": "a618d075-7e4a-4bde-9d58-d2979696fa96",
        "name": "Project_Viewer",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_View",
                    "Model_ViewAll"
                ]
            }
        ]
    }
]

...