Skip to main content
PUT
/
platform
/
admin
/
roles
cURL
curl --request PUT \
  --url https://api.example.com/platform/admin/roles \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "PlatformAdministrator",
  "description": "Grants full platform administration capabilities.",
  "permissions": [
    "ManagePlatform",
    "ManageTenants",
    "ManageRoles",
    "ManageBlockchains"
  ],
  "id": 1
}
'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Query Parameters

​
api-version
string | null

Body

application/json

Request to update an existing platform-level role.

​
name
string

Name assigned to the role.

Example:

"PlatformAdministrator"

​
description
string

Rich description outlining the role purpose and capabilities.

Example:

"Grants full platform administration capabilities including tenant management and system configuration."

​
permissions
string[]

Array of permission names granted to this role.

Example:
[
  "ManagePlatform",
  "ManageTenants",
  "ManageRoles"
]
​
id
integer<int64>

Identifier of the platform role to update.

Example:

1

Response

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object[] | null

The result value returned when the operation is successful.