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

idstring
required·

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

1 supported
Amazon Web Services
supported
accountstring

The account, subscription or project this object belongs to.

References: Accounts → id
1 supported
Amazon Web Services
supported
allowed_actionsstring[]

Permitted actions with wildcards intact, e.g. 's3:' or 'ec2:Describe' -- never expanded. An empty array means the document grants nothing; null means the document could not be read (see unreadable_fields).

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 (a restriction, not a grant).

1 supported
Amazon Web Services
supported
collected_atstring · date-time

When Truto read this object from the provider, in UTC ISO 8601 with offset. Not the request time, and not a provider-supplied timestamp.

1 supported
Amazon Web Services
supported
created_atstring · date-time

When the definition was created.

1 supported
Amazon Web Services
supported
definition_idstring

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

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
is_customboolean

Whether the customer authored this, as opposed to a provider-supplied built-in.

1 supported
Amazon Web Services
supported
namestring

The policy or role name as the provider names it.

1 supported
Amazon Web Services
supported
native_typestring

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
not_actionsstring[]

Actions under a NotAction clause, kept separate from allowed_actions. Combined with Allow, this permits everything EXCEPT these actions -- the inverse of a normal action list.

1 supported
Amazon Web Services
supported
not_resourcesstring[]

Resources under a NotResource clause. Combined with Allow, this excludes these resources rather than including them.

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
providerstring

Which cloud this object was read from.

Possible values:
awsazuregcp
1 supported
Amazon Web Services
supported
provider_idstring

The provider's own identifier, verbatim -- a full ARN, resource id, or self-link. Never truncated or normalised. Use it to find the object in the provider's console.

1 supported
Amazon Web Services
supported
raw_documentstring

The provider's raw policy document as a string, in its native encoding. AWS IAM documents are URL-encoded (RFC 3986); Organizations and Identity Center inline documents are plain JSON.

1 supported
Amazon Web Services
supported
regionstring

Where the object is located. 'global' marks resources with no region (e.g. IAM, a GCP VPC network). If the provider gives none, the collector's queried region is used instead and flagged in unreadable_fields.

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

Raw data returned from the remote API call.

1 supported
Amazon Web Services
supported
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, key/value normalisation, or merging across providers. An empty object means no tags; unreadable tags appear in unreadable_fields instead.

1 supported
Amazon Web Services
supported
unreadable_fieldsobject[]

Fields on this object that could not be read, and why. An empty array means everything was read. Use this to tell a real value from a missing one.

1 supported
Amazon Web Services
supported
3 properties
detailstring

Additional detail on the reason, when there is any.

fieldstring

The property on this resource that could not be read.

reasonstring

Why the field could not be read. available_on_get: Not read on list to keep the list fast; call GET for this resource's id to get it.

Possible values:
not_supported_by_providernot_configuredpermission_deniednot_collectedcollection_errorpartially_collectedavailable_on_get
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())