Preview — pending review
This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.
Delete a custom role
Deletes a custom role from the active scope ("Delete" / "Remove" in the role detail page, behind a confirm
dialog). Built-in roles cannot be deleted. Deletion follows the platform soft-delete workflow: the
role enters a visible deletion state, disappears from role pickers, and on failure remains in a
recoverable, queryable state.
Validation: role must exist and be visible to the caller (else 404 NOT_FOUND); destructive-action
permission (iam:manage, owner/admin) is enforced (else 403 FORBIDDEN); built-in roles reject deletion
with 403; roles with active assignments, attachments, locks, or retention holds are blocked with
409 DEPENDENCY_BLOCKED listing the blocking principals until every assignment is removed.
Async & state: Asynchronous soft delete; returns 202 with an Operation (action iam.role.delete)
progressing PENDING → RUNNING → SUCCEEDED (FAILED restores the role to its previous queryable state).
A resource.updated SSE frame with kind iam.role and a deletion patch is emitted, after which the
role no longer appears in list/view reads.
Errors: 401 unauthenticated; 403 when the caller lacks destructive permission or targets a
built-in role; 404 unknown role; 409 DEPENDENCY_BLOCKED while assignments or locks remain;
500 on internal failure.
Idempotency/Concurrency: This operation does not use Idempotency-Key; it may be omitted
and a sent one is ignored. The role is deleted inline and a new already-SUCCEEDED Operation is
returned; repeating the delete after it succeeded answers 404 NOT_FOUND because the role is
gone. This operation does not check If-Match; a sent one is ignored.
bearerTokenAuthorizationBearer <token>An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.
scopeId*stringOpaque ownership+authorization scope resolving to tenant + subscription + project.
roleId*stringRole identifier of the custom role to delete.
Role deletion accepted; returns the tracking Operation.
application/json- response
A long-running operation record. GET /operations/{operationId} returns its current state.
id*stringOperation identifier, unique platform-wide.
action*stringCanonical action id that started this operation, e.g. compute.instance.create.
state*OperationStateState machine for long-running operations. PENDING and RUNNING are transitional; the rest are terminal.
"PENDING""RUNNING""SUCCEEDED""FAILED""CANCELLED"resourceKind?|Kind of the target resource (matches RealtimeEvent.kind), null for resource-less actions.
resourceId?|Identifier of the target resource; null until the resource is allocated.
resourceName?|Human-readable name of the target resource captured when the operation was opened; null when unknown or the resource has been deleted (clients fall back to resourceId).
principalId?|Subject id (user id/email or service-account id) of the actor that initiated this operation, captured at the create chokepoint; null on internal/worker paths with no request-scoped principal or for historical rows. This is the real actor the Activity feed renders.
sourceIp?|Source IP address of the request that initiated this operation; null when unavailable (internal/worker paths, historical rows).
progressPercent?|Best-effort progress; null when the action does not report progress.
0 <= value <= 100error?|nullPopulated only when state is FAILED (or CANCELLED with partial rollback notes).
warning?|nullNon-fatal degradation recorded on an operation that still SUCCEEDED - the primary action completed but something explicitly requested could not be delivered (e.g. publicIp was requested at instance create but no floating IP could be assigned). On a CANCELLED create it reports that the provider resource had already been created and was kept (live and billed until deleted; details.disposition = left_in_place). Same code+message shape as error so clients render both uniformly; null when the operation ran without degradation.
startedAt?|When the worker began executing; null while PENDING.
finishedAt?|When a terminal state was reached; null while transitional.
createdAt*stringupdatedAt*stringcurl -X DELETE "https://example.com/scopes/string/iam/roles/string"{ "id": "string", "action": "string", "state": "PENDING", "resourceKind": "string", "resourceId": "string", "resourceName": "string", "principalId": "string", "sourceIp": "string", "progressPercent": 0, "error": { "code": "string", "message": "string", "field": "string", "details": {}, "retryable": false }, "warning": { "code": "string", "message": "string", "field": "string", "details": {}, "retryable": false }, "startedAt": "string", "finishedAt": "string", "createdAt": "string", "updatedAt": "string"}