Skip to main content

Update Role Name

Updates the name of a specified role.

Use this endpoint to keep role names aligned with team, project, or environment changes in an external governance workflow. Obtain the roleId from List Roles before calling this API.

After the request succeeds, call List Roles to verify that the role list shows the updated name.

Keep the requestId from the response for troubleshooting or audit review.

Request URL: /openapi/v1/role/name/update

Request Method: POST

Request Parameters

ParameterTypeRequiredDescriptionExample
roleIdStringYesRole ID. Call List Roles to obtain it.2394
nameStringYesNew role name.Dev-Test

Request Example

{
"roleId": "2394",
"name": "Dev-Test"
}

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request is successful.true
requestIdStringRequest ID.Kv5t4ZXG-flllbARnihgd9QHdigy4BWU

Successful Invocation Example

{
"success": true,
"requestId": "Kv5t4ZXG-flllbARnihgd9QHdigy4BWU"
}