Identity & Access Management

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.

Disable a service account (stop token issuance)

POST
/scopes/{scopeId}/iam/service-accounts/{serviceAccountId}/actions/disable

Disables the selected service account (UI "Disable" on the detail header and in list row menus; also a bulk action over selected rows). While disabled the account stops issuing tokens immediately — the UI toast reads "Service account disabled — token issuance stopped" — and the list/detail badge flips to the stopped channel. The resulting state is visible to subsequent reads. Credential revocation: in the same transaction every non-revoked key of the account turns terminal revoked and every ACTIVE API token (pc_live_…) the account holds or created turns REVOKED; each one fails authentication (401) from the next request. Re-enabling the account does NOT revive them — new keys must be minted. When anything was revoked, a SUCCEEDED iam.service_account.credentials.revoke Operation is recorded for the activity/audit feed. Validation: account must exist and be visible in the scope (else 404 NOT_FOUND); current state must permit disable — an account already in disabled is rejected as a state conflict → 409 CONFLICT; caller must hold an IAM command permission (owner|admin) else 403 FORBIDDEN. Async & state: Applied inline — the status flips to disabled at once and a terminal, already- SUCCEEDED tracking Operation is returned (202) so a later GET /operations/{id} resolves it as done and the acting principal is stamped for the activity/audit feed. Errors: 401 unauthenticated; 403 lacks command permission; 404 unknown account; 409 CONFLICT when the account is already disabled or a concurrent state change is in flight; 500 command execution failure. Idempotency/Concurrency: Idempotency-Key is optional (recommended); replay of the same key returns the original Operation so UI retries are safe and the account is not double-transitioned.

Authorization

bearerToken
headerAuthorizationBearer <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.

Path Parameters

scopeId*string

Opaque ownership+authorization scope resolving to tenant + subscription + project.

serviceAccountId*string

Service account identifier.

Header Parameters

Idempotency-Key?string

Optional; recommended for safe retries. When sent, the same key+body within 24h replays the original result and the same key with a different body is 409 CONFLICT; keys are unique per tenant. When an API token or service-account (bearer) caller omits it, the request is applied once with no replay protection (a retry may apply it again). A console session gets one from the edge.

Formatuuid

Response Body

Disable accepted; track progress via the returned Operation.

application/json
  1. response

A long-running operation record. GET /operations/{operationId} returns its current state.

id*string

Operation identifier, unique platform-wide.

action*string

Canonical action id that started this operation, e.g. compute.instance.create.

state*OperationState

State machine for long-running operations. PENDING and RUNNING are transitional; the rest are terminal.

Value in"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.

Range0 <= value <= 100
error?|null

Populated only when state is FAILED (or CANCELLED with partial rollback notes).

warning?|null

Non-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*string
updatedAt*string
curl -X POST "https://example.com/scopes/string/iam/service-accounts/string/actions/disable"
{  "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"}