Get specific role

GET 
/roles/organizations/:organization/roles/:id

Retrieve name and description for a specific role

Request

Path Parameters

organization stringrequired
id stringrequired

Responses

200

Success

text/plain

Schema

Schema

id stringnullable
name stringnullable
description stringnullable
isFrozenForChanges boolean
isOrganizationRole boolean

scope

object

organizationId stringnullable

projectId stringnullable

resourcePath stringnullable

resourceType stringnullable

viewerSceneId stringnullable

isOrgLevel boolean

Example (from schema)

{
  "id": "string",
  "name": "string",
  "description": "string",
  "isFrozenForChanges": true,
  "isOrganizationRole": true,
  "scope": {
    "organizationId": "string",
    "projectId": "string",
    "resourcePath": "string",
    "resourceType": "string",
    "viewerSceneId": "string",
    "isOrgLevel": true
  }
}

application/json

Schema

Schema

id stringnullable
name stringnullable
description stringnullable
isFrozenForChanges boolean
isOrganizationRole boolean

scope

object

organizationId stringnullable

projectId stringnullable

resourcePath stringnullable

resourceType stringnullable

viewerSceneId stringnullable

isOrgLevel boolean

Example (from schema)

{
  "id": "string",
  "name": "string",
  "description": "string",
  "isFrozenForChanges": true,
  "isOrganizationRole": true,
  "scope": {
    "organizationId": "string",
    "projectId": "string",
    "resourcePath": "string",
    "resourceType": "string",
    "viewerSceneId": "string",
    "isOrgLevel": true
  }
}

text/json

Schema

Schema

id stringnullable
name stringnullable
description stringnullable
isFrozenForChanges boolean
isOrganizationRole boolean

scope

object

organizationId stringnullable

projectId stringnullable

resourcePath stringnullable

resourceType stringnullable

viewerSceneId stringnullable

isOrgLevel boolean

Example (from schema)

{
  "id": "string",
  "name": "string",
  "description": "string",
  "isFrozenForChanges": true,
  "isOrganizationRole": true,
  "scope": {
    "organizationId": "string",
    "projectId": "string",
    "resourcePath": "string",
    "resourceType": "string",
    "viewerSceneId": "string",
    "isOrgLevel": true
  }
}

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

Loading...