# List Permission definitions

> Source: https://truto.one/docs/api-reference/unified-cloud-infrastructure-api/permissiondefinitions/list/

`GET /unified/cloud-infrastructure/permission_definitions`

Resource: **PermissionDefinitions** · API: **Unified Cloud Infrastructure API**

## Supported integrations

Amazon Web Services

## Query parameters

- **`integrated_account_id`** _(string, required)_
  The ID of the integrated account to use for the request.
- **`truto_response_format`** _(string)_
  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`.
  Allowed: `unified`, `raw`, `normalized`, `stream`, `debug`
- **`truto_key_by`** _(string)_
  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.
- **`truto_ignore_limit`** _(boolean)_
  Ignores the `limit` query parameter.
- **`truto_ignore_remote_data`** _(boolean)_
  Excludes the `remote_data` attribute from the response.
- **`truto_exclude_fields`** _(array<string>)_
  Array of fields to exclude from the response.
- **`remote_query`** _(object)_
  Query parameters to pass to the underlying API without any transformations. Refer [this guide](https://truto.one/docs/api-reference/overview/querying#remote-query-parameters) to see how to structure the query parameters.

## Response body

- **`result`** _(array<object>)_
  List of Permission definitions
  - **`id`** _(string, 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.
  - **`provider_ref`** _(string, 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.
  - **`provider`** _(string, required)_
    Which cloud this object was read from.
    Allowed: `aws`, `azure`, `gcp`
  - **`account_ref`** _(string, 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.
  - **`region`** _(string)_
    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.
  - **`native_type`** _(string, 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.
  - **`tags`** _(object)_
    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.
  - **`collected_at`** _(string, 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.
  - **`unreadable_fields`** _(array<object>)_
    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'.
  - **`remote_data`** _(object)_
    Raw data returned from the remote API call.
  - **`definition_ref`** _(string, required)_
    The provider's own identifier for the policy or role definition.
  - **`name`** _(string, required)_
    The policy or role name as the provider names it.
  - **`is_custom`** _(boolean, required)_
    Whether the customer authored this. Provider built-ins are recognised by name and their documents are not re-fetched per tenant.
  - **`allowed_actions`** _(array<string>)_
    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.
  - **`denied_actions`** _(array<string>)_
    Explicitly denied actions, with wildcards intact.
  - **`not_actions`** _(array<string>)_
    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.
  - **`not_resources`** _(array<string>)_
    Resources carried under a NotResource clause, kept separate for the same reason.
  - **`resource_scope`** _(array<string>)_
    The resources the permissions apply to, with wildcards intact.
  - **`has_wildcard_action`** _(boolean)_
    Whether any statement grants a bare action wildcard. Derived.
  - **`has_wildcard_resource`** _(boolean)_
    Whether any statement applies to a bare resource wildcard. Derived.
  - **`raw_document`** _(string)_
    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.
  - **`attachment_count`** _(integer)_
    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.
  - **`permissions_boundary_usage_count`** _(integer)_
    How many principals use this definition as a permissions boundary -- a restriction, not a grant.
  - **`assignment_count`** _(integer)_
    Total assignments, where the provider exposes a single combined number.
  - **`created_at`** _(string)_
    When the definition was created.
  - **`updated_at`** _(string)_
    When the definition was last modified.
- **`next_cursor`** _(string)_
  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.
- **`debug`** _(object)_
  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`.
  - **`requestUrl`** _(string)_
  - **`requestOptions`** _(object)_
  - **`data`** _(unknown)_
  - **`responseHeaders`** _(object)_
  - **`nextCursor`** _(string)_
  - **`isLooping`** _(boolean)_
  - **`isEmptyResult`** _(boolean)_
  - **`resultCount`** _(number)_

## Code examples

### Truto CLI

```bash
truto unified cloud-infrastructure permissiondefinitions \
  -a '<integrated_account_id>' \
  -o json
```

### Truto TS SDK

```typescript
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);
```

### Truto Python SDK

```python
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

```bash
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'
```

### JavaScript

```javascript
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);
```

### Python

```python
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())
```