Delete a role, and revoke every key granted it

DELETE

/provision/databases/{id}/roles/{roleId}

The passwordless sessions and api keys granted the role are revoked
(kept, for the audit trail); the role is soft-deleted so they still
have a name to point at.

Capability: access:write (area resource, on the database).

Request

Path Params

Responses

🟢200

application/json

Deleted

Bodyapplication/json

🟠404

🟠400ValidationError

🟠401KlockUnauthorized

🟠403CapabilityMissing

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://api.prod-orm.io/provision/databases//roles/'

Response Example

200 - Example 1

{
    "role": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "description": "string",
        "scope": {
            "ops": [
                "read"
            ],
            "tables": [
                "string"
            ],
            "columns": {
                "property1": [
                    "string"
                ],
                "property2": [
                    "string"
                ]
            }
        },
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z",
        "holders": {
            "grants": 0,
            "keys": 0
        }
    },
    "revoked": {
        "grants": 0,
        "keys": 0
    }
}

Modified at 2026-10-05 14:01:12

Change what a role permits

Grant a role, which mints a key