Skip to main content
An action is one operation of the Telnyx API, named for the resource it touches and what it does to it, such as number.update. Every role is written in actions, and every request is decided on the action its route declares.

Naming

An action ID is <resource>.<verb>. The resource is the API resource, in its singular or plural form as the owning product declares it, and the verb is what the operation does.
One action can cover several operations, such as api_keys.read for both the list and the single key.

The Catalog

GET /v2/iam/actions lists every action, with the operations it covers.
GET /v2/iam/actions/{id} returns one action.
GET /v2/iam/actions/api_keys.read
To find the actions behind a route, search by its path.
GET /v2/iam/actions?filter[path][contains]=number_orders

Wildcards

A statement in a role names actions exactly, or with a wildcard.
  • number_order.* covers every action whose ID starts with number_order..
  • * covers every action.
A wildcard whose prefix matches no action is rejected like an unknown action.

IAM’s Own Actions

Managing IAM is actions too. They are declared like any other, and only the organization owner may send the requests behind them, the catalog and the service account routes included. A service account token is refused on every /v2/iam route.

Routes Without an Action

Every route IAM manages declares one action. A route that declares none cannot be allowed by any role, so a principal IAM manages is refused on it, apart from a few portal, OAuth consent, and agent sign-in routes that every signed-in user may reach. Telnyx is adding an action to every customer-facing route that lacks one, and a route opens to roles once it has one.