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.
Create a custom role
Creates a custom IAM role in the active scope from the "Create custom role" builder. The caller
supplies a display name, optional description, the scope levels the role may be assigned at, and a
permission matrix mapping each platform resource key (compute, storage, network, loadbalancer,
kubernetes, observability, billing, budgets, iam, tokens, branding, audit) to manage|read|none.
On acceptance the role is created with custom: true, builtIn: false, zero members, and becomes
discoverable in the scoped role list; it is then selectable in assignment dialogs.
Validation: name is required, unique among roles in the tenant (duplicate → 409 CONFLICT) and
1–64 chars; permissions keys must be known resource keys and values one of manage|read|none;
assignableScopes entries must be subscription|project; cross-resource references (scope,
directory) must be accessible — violations → 422 VALIDATION_FAILED.
Async & state: Asynchronous; returns 202 with an Operation (action iam.role.create) that moves
PENDING → RUNNING → SUCCEEDED once the role document is written and RBAC propagation completes
(FAILED on error). A resource.updated SSE frame with kind iam.role is emitted when the new role
appears; the role is then visible to subsequent list/view reads.
Errors: 401 unauthenticated; 403 when the caller lacks iam:manage (owner/admin) in the scope;
409 CONFLICT when a role with the same name already exists; 422 when required fields are missing or
the permission matrix contains unknown keys/levels; 500 on internal failure.
Idempotency/Concurrency: Idempotency-Key is required; replaying the same key returns the original
202 Operation without creating a duplicate role. No If-Match applies to creation.
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.
Idempotency-Key*stringRequired: this operation creates a new resource asynchronously, so a retry without the key would create a second one. Same key+body within 24h replays the original result; the same key with a different body is 409 CONFLICT. Keys are unique per tenant (the same key in two tenants is two different requests). An API token or service-account (bearer) caller MUST send it -- a request without it is refused with 400 IDEMPOTENCY_KEY_REQUIRED (ErrIdempotencyKeyRequired); reuse the same key on every retry of one logical request. A console session gets one from the edge.
uuidapplication/json- body
Payload for the "Create custom role" builder.
name*stringDisplay name of the new custom role; unique within the tenant.
^[^\p{C}\p{Z}\x{10000}-\x{10FFFF}](?:[^\p{C}\p{Zl}\p{Zp}\x{10000}-\x{10FFFF}]*[^\p{C}\p{Z}\x{10000}-\x{10FFFF}])?$1 <= length <= 255description?stringOptional human-readable summary of the role.
length <= 255assignableScopes?array<>Scope levels the role may be assigned at. Defaults to both levels when omitted.
permissions*Permission matrix — known resourceKey → access level.
Role creation 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 POST "https://example.com/scopes/string/iam/roles" \ -H "Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "permissions": { "property1": "manage", "property2": "manage" } }'{ "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"}