Skip to main content

policyEntities

Return the complete catalog of ABAC entities — the kinds of things an action can apply to.

An entity is the {entity} portion of an action id. Use this alongside policyActions when you want to group actions by what they apply to (for example rendering a UI that collapses all project:* actions under a single "Projects" header).

Results are sorted alphabetically by id.

policyEntities(
  organizationId: ID!
): [PolicyEntity!]!

Arguments​

policyEntities.organizationId ● ID! non-null scalar {#organization-id}​

Your organization's unique identifier.

Type​

PolicyEntity object​

A kind of thing an ABAC policy can be attached to — a project, an environment, a resource, and so on.

Every action in the policy catalog acts on exactly one entity, encoded as the prefix of the action id (project in project:view). Use policyEntities to enumerate every entity with its description when building a policy-authoring UI.