Skip to main content

Delete Role

Deletes a specified role.

Use this endpoint when an external governance process needs to remove a role that is no longer used. Obtain and confirm the roleId from List Roles before calling this API.

After the request succeeds, call List Roles again to verify that the role no longer appears in the role list.

Keep the requestId from the response for troubleshooting or audit review, and update downstream automation so it no longer references the deleted role ID.

Request URL: /openapi/v1/role/delete

Request Method: POST

Request Parameters

ParameterTypeRequiredDescriptionExample
roleIdStringYesRole ID. Call List Roles to obtain it.2394

Request Example

{
"roleId": "2394"
}

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request is successful.true
requestIdStringRequest ID.Qz3a1RFA-ciiilINnfedb5BFdfen3OTD

Successful Invocation Example

{
"success": true,
"requestId": "Qz3a1RFA-ciiilINnfedb5BFdfen3OTD"
}