Skip to main content

UpsertPermissionRequest

uidstring

Unique identifier of the permission (optional for create, used for update identification)

Example: 019619df-4768-76b3-8ab3-4414dcf29ff1
codestringrequired

Code of the permission

Example: portfolio-123
typestringrequired

Type of the permission

Possible values: [ASSET, PROFILE, SCOPE, SCOPE_GROUP, REPORT, REPORT_GROUP]

Example: ASSET
subTypestring

Subtype of the permission

Possible values: [BUILDING, BUILDING_GROUP, FACILITY, PORTFOLIO, COMPANY, APPLICATION, RIGHT, POWERBI, METABASE]

Example: PORTFOLIO
labelstringrequired

Display label of the permission

Example: Alpha Portfolio
descriptionstring

Description of the permission

Example: The Alpha Portfolio of buildings
scopes object[]

Scopes associated with this permission

  • Array [
    • codestringrequired

    Code of the permission scope

    Examples:
    Example: stonal.application.etl
  • ]
    • reports object[]

    Reports associated with this permission

  • Array [
    • uidstringrequired

    UID of the report to associate with this permission

    Example: 550e8400-e29b-41d4-a716-446655440000
  • ]
    • UpsertPermissionRequest
    {
      "uid": "019619df-4768-76b3-8ab3-4414dcf29ff1",
      "code": "portfolio-123",
      "type": "ASSET",
      "subType": "PORTFOLIO",
      "label": "Alpha Portfolio",
      "description": "The Alpha Portfolio of buildings",
      "scopes": [
        {
          "code": "stonal.application.etl"
        }
      ],
      "reports": [
        {
          "uid": "550e8400-e29b-41d4-a716-446655440000"
        }
      ]
    }