Skip to content

List the Cedar action catalog.

GET
/v1/iam/actions
Code sample: Shell / cURL
curl --request GET \
--url https://stratum.example.com/v1/iam/actions \
--header 'Authorization: Bearer <token>'

Every <service>:<Verb> action the install understands — the policy builder’s action picker. Any authenticated principal.

Filters, both optional and combinable. resourceType keeps the actions that can apply to a resource of that type: the ones a resource policy on it accepts. available=true drops the actions of a registry service that is switched off or does not exist on this install’s profile (an action with no registryService is always kept). conditionKeys and resourceTypes are never filtered.

resourceType
string

A resource type token from resourceTypes (the ARN <type>), e.g. instance. An unknown token is a 400 UNKNOWN_RESOURCE_TYPE.

available
boolean

true keeps only the actions whose registry service is on here. false or absent returns the whole catalog.

Action catalog.

Media typeapplication/json
object
actions
required
Array<object>

One authorizable action enriched for the policy builder. service/verb/description/mutating are derived from the action string; group by service, label with description, badge read-vs-write with mutating.

object
action
required

The <service>:<Verb> action name.

string
service
required
string
verb
required
string
description
required

Human label derived from the verb, e.g. “Start Instance”.

string
mutating
required

False for read actions (List/Describe/Get/Read/Verify/Detect).

boolean
resourceTypes

Resource type token(s) the action targets, derived from the verb via the resource-type registry. Absent/empty for service-wide actions (Manage, Reconcile, Login, console verbs). Values are the ARN <type> tokens in resourceTypes.

Array<string>
registryService

The service-registry key whose switch governs the action, e.g. db, s3, client-vpn, security. Absent for the platform’s always-on services (compute, network, IAM, …). The registry’s GET /v1/services reports whether that key is on.

string
conditionKeys
required
Array<object>

A condition key the builder can offer. v1 supports resource-tag matching only; <key> is any tag key on the target resource.

object
key
required
string
operators
required
Array<string>
description
required
string
resourceTypes
required

The resource-type registry — the distinct types an action’s resourceTypes can reference, for the builder’s resource picker + display labels.

Array<object>

One authorizable resource type. type is the ARN <type> token + resource-policy key prefix; display is the human label; service is the owning service.

object
type
required
string
service
required
string
display
required
string

Example generated

{
"actions": [
{
"action": "example",
"service": "example",
"verb": "example",
"description": "example",
"mutating": true,
"resourceTypes": [
"example"
],
"registryService": "example"
}
],
"conditionKeys": [
{
"key": "example",
"operators": [
"example"
],
"description": "example"
}
],
"resourceTypes": [
{
"type": "example",
"service": "example",
"display": "example"
}
]
}

Bad request.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example

{
"issues": [
{
"code": "ACTION_NOT_APPLICABLE",
"action": "compute:CreateVpc"
}
]
}

Missing or invalid token.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example

{
"issues": [
{
"code": "ACTION_NOT_APPLICABLE",
"action": "compute:CreateVpc"
}
]
}
WWW-Authenticate
string