Skip to main content
POST
Delete a role

Restrictions

Usage

  • While members still hold the role, the call fails with 400 ReferenceExist and lists them in data.refs (kind member); set is_force to true to revoke the role from all of them and then delete it.
  • A role selected as a default role in the SSO configuration cannot be deleted, even with is_force; the call fails with 400 ReferenceExist until it is unselected there.
  • A role ID that does not exist or was already deleted is ignored and the call succeeds.
  • The built-in roles (2, 6, 8) cannot be deleted: with or without is_force, the call returns 400 InvalidParameter (Preset roles cannot be modified.).
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Request to delete a role.

role_id
integer<uint64>
required

Role ID to delete. Get IDs from POST /role/list (built-in roles: 2=Admin, 6=Responder, 8=Viewer).

is_force
boolean
default:false

When false (default), deletion fails with ReferenceExist while members still hold the role, listing them in data.refs. When true, the role is first revoked from all holders and then deleted. Does not bypass the SSO default-role check.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Empty object returned on success for operations with no meaningful payload.