Delete role

Remove a database role. References from grants, policies, users or other roles prevent deletion unless cascade is requested.

DELETE /v1/tenants/{tenant}/db/roles/{name}

Remove a role after checking dependenciesCascade can also affect grants, memberships, inheritance and policies.

Review role referencesIdentify users, roles and policies that rely on it.
Choose deletion behaviorReferences block deletion unless cascade is requested.
Inspect affected dependenciesReview the returned deletion and cascade details.

Before you start

Use your database bearer token.

Connection setup

Use an identity authorized to manage access. Remove dependent grants, users and policies, or review the cascade option.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`name`	`string`	Required

Query parameters

Field	Type	Required
`cascade`	`boolean`	Optional

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

deleted reports the role removal. When cascade is requested, the cascaded groups identify affected grants, members, inherited roles and policies. Review these dependencies before using cascade.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
409	Resolve the conflict before retrying.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
501	Check deployment support for this operation.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request DELETE "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/db/roles/demo_reader" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "deleted": true,
  "cascaded": {
    "grants": [],
    "inherited_by": [],
    "members": [],
    "rls_policies": []
  }
}

Illustrates deletion after dependencies have been removed.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

Query parametersCopy Anchor Link

HeadersCopy Anchor Link