Skip to content
GET /unified/cloud-infrastructure/permission_definitions

Query Parameters

Refer Specifying query parameters in Truto APIs

Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_key_bystring

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limitboolean

Ignores the limit query parameter.

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body

debugobject

Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. data is the parsed upstream body; when its JSON form exceeds 1 MiB it is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }, where truto_excerpt is the leading bytes of that body. The same applies to a string requestOptions.body. null for static responses or when truto_skip_api_call=true.

data
isEmptyResultboolean
isLoopingboolean
nextCursorstring
requestOptionsRecord<string, any>
requestUrlstring
responseHeadersRecord<string, any>
resultCountnumber
next_cursorstring

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.

resultobject[]

List of Permission definitions

account_refstring
required·

The account, subscription or project the object belongs to. An object with no account cannot be attributed to an environment, so this is always present for objects that live inside an account.

1 supported
Amazon Web Services
supported
collected_atstring · date-time
required·

When Truto actually read this object from the provider, in UTC ISO 8601 with the offset present. Not when the request was made and not a provider timestamp. Drives consumer staleness rules.

1 supported
Amazon Web Services
supported
definition_refstring
required·

The provider's own identifier for the policy or role definition.

1 supported
Amazon Web Services
supported
idstring
required·

Truto's stable unified identifier for this object. Opaque; use provider_ref to address the object in the provider's own console or API.

1 supported
Amazon Web Services
supported
is_customboolean
required·

Whether the customer authored this. Provider built-ins are recognised by name and their documents are not re-fetched per tenant.

1 supported
Amazon Web Services
supported
namestring
required·

The policy or role name as the provider names it.

1 supported
Amazon Web Services
supported
native_typestring
required·

The provider's own type string, unmodified -- for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.

1 supported
Amazon Web Services
supported
providerstring
required·

Which cloud this object was read from.

Possible values:
awsazuregcp
1 supported
Amazon Web Services
supported
provider_refstring
required·

The provider's own unbroken identifier, passed through verbatim -- a full ARN, resource id or self-link. Never truncated, prefixed or normalised. This is the customer-facing key used to find the object in the console.

1 supported
Amazon Web Services
supported
allowed_actionsstring[]

Permitted actions with wildcards intact -- 's3:' and 'ec2:Describe' survive verbatim. Never expanded: expanding bakes in a snapshot of the provider action catalogue and destroys the operator's ability to see that the policy says '*'. An empty array means the document grants nothing; a document that could not be read leaves this null with an unreadable_fields entry.

1 supported
Amazon Web Services
supported
assignment_countinteger

Total assignments, where the provider exposes a single combined number.

1 supported
Amazon Web Services
supported
attachment_countinteger

How many principals this definition is attached to as a grant. Kept separate from permissions_boundary_usage_count, because summing a count of grants with a count of restrictions destroys a security-relevant distinction.

1 supported
Amazon Web Services
supported
created_atstring · date-time

When the definition was created.

1 supported
Amazon Web Services
supported
denied_actionsstring[]

Explicitly denied actions, with wildcards intact.

1 supported
Amazon Web Services
supported
has_wildcard_actionboolean

Whether any statement grants a bare action wildcard. Derived.

1 supported
Amazon Web Services
supported
has_wildcard_resourceboolean

Whether any statement applies to a bare resource wildcard. Derived.

1 supported
Amazon Web Services
supported
not_actionsstring[]

Actions carried under a NotAction clause, kept separate from allowed_actions. An Allow with NotAction permits everything EXCEPT the listed actions, which is the inverse of what an action list implies.

1 supported
Amazon Web Services
supported
not_resourcesstring[]

Resources carried under a NotResource clause, kept separate for the same reason.

1 supported
Amazon Web Services
supported
permissions_boundary_usage_countinteger

How many principals use this definition as a permissions boundary -- a restriction, not a grant.

1 supported
Amazon Web Services
supported
raw_documentstring

The provider's own policy document as a string, for consumers whose parsing needs to be more careful than a flat action list allows. Carried in the provider's native encoding: AWS IAM documents are URL-encoded RFC 3986 while Organizations and Identity Center inline documents are plain JSON, and the two are never decoded with the same rule.

1 supported
Amazon Web Services
supported
regionstring

Where the object is. A compliance answer in its own right, not metadata. The literal string 'global' is emitted for genuinely global resources (for example IAM, or a GCP VPC network) rather than guessing a region. Never invented: where the provider does not return a location and none can be derived, the collector's queried region is used and that substitution is recorded in unreadable_fields.

1 supported
Amazon Web Services
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

resource_scopestring[]

The resources the permissions apply to, with wildcards intact.

1 supported
Amazon Web Services
supported
tagsobject

Key-value pairs exactly as the customer set them: no case folding, no key or value normalisation, no merging of separate provider concepts. Present on every object because tags are the primary input for environment classification. An empty object means the object carries no tags; tags that could not be read are recorded in unreadable_fields instead.

1 supported
Amazon Web Services
supported
unreadable_fieldsobject[]

Per-object list of the fields that could not be read, and why -- the brief section 8.4 answer, chosen over per-field sentinel values. Each entry is an object with 'field' (the property name on this resource), 'reason' (a reason code) and an optional human-readable 'detail'. Reason codes: not_supported_by_provider, not_configured, permission_denied, not_collected, collection_error, partially_collected. An empty array means every property on this object was read successfully. A property absent from this array and null in the payload means the provider genuinely returned no value, which is different from 'we could not look'.

1 supported
Amazon Web Services
supported
updated_atstring · date-time

When the definition was last modified.

1 supported
Amazon Web Services
supported
truto unified cloud-infrastructure permissiondefinitions \
  -a '<integrated_account_id>' \
  -o json
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'cloud-infrastructure',
  'permissiondefinitions',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    async for item in truto_api.unified_api.list(
        "cloud-infrastructure",
        "permissiondefinitions",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())
curl -X GET 'https://api.truto.one/unified/cloud-infrastructure/permission_definitions?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/cloud-infrastructure/permission_definitions?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/cloud-infrastructure/permission_definitions"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())