Calculate roles with access to scope

POST 
/roles/roles-with-access

Calculate the list of roles that have access to a specific scope

Request

application/json

Body

organizationId stringnullable
projectId stringnullable
resourcePath stringnullable
resourceType stringnullable
viewerSceneId stringnullable

Responses

200

Success

text/plain

Schema

Schema

• Array [

permission

object

id stringnullable

name stringnullable

description stringnullable

children undefined[]nullable

childrenIds string[]nullable

isRootOnly boolean

isReadOnlyPermission boolean

roleAssignmentInfo

object[]

nullable

Array [

role

object

id stringnullable

name stringnullable

description stringnullable

isFrozenForChanges boolean

isOrganizationRole boolean

scope

object

organizationId stringnullable

projectId stringnullable

resourcePath stringnullable

resourceType stringnullable

viewerSceneId stringnullable

isOrgLevel boolean

type PermissionType (string)

Possible values: [Direct, Inherited]

scope

object

organizationId stringnullable

projectId stringnullable

resourcePath stringnullable

resourceType stringnullable

viewerSceneId stringnullable

isOrgLevel boolean

]

• ]

Example (from schema)

[
  {
    "permission": {
      "id": "string",
      "name": "string",
      "description": "string",
      "children": [
        null
      ],
      "childrenIds": [
        "string"
      ],
      "isRootOnly": true,
      "isReadOnlyPermission": true
    },
    "roleAssignmentInfo": [
      {
        "role": {
          "id": "string",
          "name": "string",
          "description": "string",
          "isFrozenForChanges": true,
          "isOrganizationRole": true,
          "scope": {
            "organizationId": "string",
            "projectId": "string",
            "resourcePath": "string",
            "resourceType": "string",
            "viewerSceneId": "string",
            "isOrgLevel": true
          }
        },
        "type": "Direct",
        "scope": {
          "organizationId": "string",
          "projectId": "string",
          "resourcePath": "string",
          "resourceType": "string",
          "viewerSceneId": "string",
          "isOrgLevel": true
        }
      }
    ]
  }
]

application/json

Schema

Schema

• Array [

permission

object

id stringnullable

name stringnullable

description stringnullable

children undefined[]nullable

childrenIds string[]nullable

isRootOnly boolean

isReadOnlyPermission boolean

roleAssignmentInfo

object[]

nullable

Array [

role

object

id stringnullable

name stringnullable

description stringnullable

isFrozenForChanges boolean

isOrganizationRole boolean

scope

object

organizationId stringnullable

projectId stringnullable

resourcePath stringnullable

resourceType stringnullable

viewerSceneId stringnullable

isOrgLevel boolean

type PermissionType (string)

Possible values: [Direct, Inherited]

scope

object

organizationId stringnullable

projectId stringnullable

resourcePath stringnullable

resourceType stringnullable

viewerSceneId stringnullable

isOrgLevel boolean

]

• ]

Example (from schema)

[
  {
    "permission": {
      "id": "string",
      "name": "string",
      "description": "string",
      "children": [
        null
      ],
      "childrenIds": [
        "string"
      ],
      "isRootOnly": true,
      "isReadOnlyPermission": true
    },
    "roleAssignmentInfo": [
      {
        "role": {
          "id": "string",
          "name": "string",
          "description": "string",
          "isFrozenForChanges": true,
          "isOrganizationRole": true,
          "scope": {
            "organizationId": "string",
            "projectId": "string",
            "resourcePath": "string",
            "resourceType": "string",
            "viewerSceneId": "string",
            "isOrgLevel": true
          }
        },
        "type": "Direct",
        "scope": {
          "organizationId": "string",
          "projectId": "string",
          "resourcePath": "string",
          "resourceType": "string",
          "viewerSceneId": "string",
          "isOrgLevel": true
        }
      }
    ]
  }
]

text/json

Schema

Schema

• Array [

permission

object

id stringnullable

name stringnullable

description stringnullable

children undefined[]nullable

childrenIds string[]nullable

isRootOnly boolean

isReadOnlyPermission boolean

roleAssignmentInfo

object[]

nullable

Array [

role

object

id stringnullable

name stringnullable

description stringnullable

isFrozenForChanges boolean

isOrganizationRole boolean

scope

object

organizationId stringnullable

projectId stringnullable

resourcePath stringnullable

resourceType stringnullable

viewerSceneId stringnullable

isOrgLevel boolean

type PermissionType (string)

Possible values: [Direct, Inherited]

scope

object

organizationId stringnullable

projectId stringnullable

resourcePath stringnullable

resourceType stringnullable

viewerSceneId stringnullable

isOrgLevel boolean

]

• ]

Example (from schema)

[
  {
    "permission": {
      "id": "string",
      "name": "string",
      "description": "string",
      "children": [
        null
      ],
      "childrenIds": [
        "string"
      ],
      "isRootOnly": true,
      "isReadOnlyPermission": true
    },
    "roleAssignmentInfo": [
      {
        "role": {
          "id": "string",
          "name": "string",
          "description": "string",
          "isFrozenForChanges": true,
          "isOrganizationRole": true,
          "scope": {
            "organizationId": "string",
            "projectId": "string",
            "resourcePath": "string",
            "resourceType": "string",
            "viewerSceneId": "string",
            "isOrgLevel": true
          }
        },
        "type": "Direct",
        "scope": {
          "organizationId": "string",
          "projectId": "string",
          "resourcePath": "string",
          "resourceType": "string",
          "viewerSceneId": "string",
          "isOrgLevel": true
        }
      }
    ]
  }
]

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

Loading...