Sign in
Roles

Update a role

Changed on
put/api/v1/{tenant}/roles/{id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/roles/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

idstring required

The role id

tenantstring required

Request body

namestring required
descriptionstring
isDefaultboolean

Example request

{
  "permissions": {
    "NAMESPACE": [
      "NAMESPACE",
      "NAMESPACE"
    ],
    "APPEXECUTION": [
      "APPEXECUTION",
      "APPEXECUTION"
    ],
    "APP": [
      "APP",
      "APP"
    ],
    "TENANT_ACCESS": [
      "TENANT_ACCESS",
      "TENANT_ACCESS"
    ],
    "SERVICE_ACCOUNT": [
      "SERVICE_ACCOUNT",
      "SERVICE_ACCOUNT"
    ],
    "AI_COPILOT": [
      "AI_COPILOT",
      "AI_COPILOT"
    ],
    "BLUEPRINT": [
      "BLUEPRINT",
      "BLUEPRINT"
    ],
    "FLOW": [
      "FLOW",
      "FLOW"
    ],
    "ROLE": [
      "ROLE",
      "ROLE"
    ],
    "GROUP": [
      "GROUP",
      "GROUP"
    ],
    "DASHBOARD": [
      "DASHBOARD",
      "DASHBOARD"
    ],
    "IMPERSONATE": [
      "IMPERSONATE",
      "IMPERSONATE"
    ],
    "TEMPLATE": [
      "TEMPLATE",
      "TEMPLATE"
    ],
    "AUDITLOG": [
      "AUDITLOG",
      "AUDITLOG"
    ],
    "SETTING": [
      "SETTING",
      "SETTING"
    ],
    "KVSTORE": [
      "KVSTORE",
      "KVSTORE"
    ],
    "EXECUTION": [
      "EXECUTION",
      "EXECUTION"
    ],
    "ASSET": [
      "ASSET",
      "ASSET"
    ],
    "USER": [
      "USER",
      "USER"
    ],
    "GROUP_MEMBERSHIP": [
      "GROUP_MEMBERSHIP",
      "GROUP_MEMBERSHIP"
    ],
    "INVITATION": [
      "INVITATION",
      "INVITATION"
    ],
    "TEST": [
      "TEST",
      "TEST"
    ],
    "CREDENTIAL": [
      "CREDENTIAL",
      "CREDENTIAL"
    ],
    "UNKNOWN": [
      "UNKNOWN",
      "UNKNOWN"
    ],
    "BINDING": [
      "BINDING",
      "BINDING"
    ],
    "SECRET": [
      "SECRET",
      "SECRET"
    ]
  }
}

Response

Role successfully updated

idstring
namestring
descriptionstring
isDefaultboolean
isManagedboolean

Example response

{
  "isDefault": true,
  "permissions": {
    "NAMESPACE": [
      "NAMESPACE",
      "NAMESPACE"
    ],
    "APPEXECUTION": [
      "APPEXECUTION",
      "APPEXECUTION"
    ],
    "APP": [
      "APP",
      "APP"
    ],
    "TENANT_ACCESS": [
      "TENANT_ACCESS",
      "TENANT_ACCESS"
    ],
    "SERVICE_ACCOUNT": [
      "SERVICE_ACCOUNT",
      "SERVICE_ACCOUNT"
    ],
    "AI_COPILOT": [
      "AI_COPILOT",
      "AI_COPILOT"
    ],
    "BLUEPRINT": [
      "BLUEPRINT",
      "BLUEPRINT"
    ],
    "FLOW": [
      "FLOW",
      "FLOW"
    ],
    "ROLE": [
      "ROLE",
      "ROLE"
    ],
    "GROUP": [
      "GROUP",
      "GROUP"
    ],
    "DASHBOARD": [
      "DASHBOARD",
      "DASHBOARD"
    ],
    "IMPERSONATE": [
      "IMPERSONATE",
      "IMPERSONATE"
    ],
    "TEMPLATE": [
      "TEMPLATE",
      "TEMPLATE"
    ],
    "AUDITLOG": [
      "AUDITLOG",
      "AUDITLOG"
    ],
    "SETTING": [
      "SETTING",
      "SETTING"
    ],
    "KVSTORE": [
      "KVSTORE",
      "KVSTORE"
    ],
    "EXECUTION": [
      "EXECUTION",
      "EXECUTION"
    ],
    "ASSET": [
      "ASSET",
      "ASSET"
    ],
    "USER": [
      "USER",
      "USER"
    ],
    "GROUP_MEMBERSHIP": [
      "GROUP_MEMBERSHIP",
      "GROUP_MEMBERSHIP"
    ],
    "INVITATION": [
      "INVITATION",
      "INVITATION"
    ],
    "TEST": [
      "TEST",
      "TEST"
    ],
    "CREDENTIAL": [
      "CREDENTIAL",
      "CREDENTIAL"
    ],
    "UNKNOWN": [
      "UNKNOWN",
      "UNKNOWN"
    ],
    "BINDING": [
      "BINDING",
      "BINDING"
    ],
    "SECRET": [
      "SECRET",
      "SECRET"
    ]
  },
  "name": "name",
  "description": "description",
  "id": "id",
  "isManaged": true
}

Changes

  • b6097dbc46aeRevision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status