# 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_id to address the object in the provider's own console or API.
  - **`provider_id`** _(string)_
    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.
  - **`provider`** _(string)_
    Which cloud this object was read from.
    Allowed: `aws`, `azure`, `gcp`
  - **`account`** _(string)_
    The account, subscription or project this object belongs to.
  - **`region`** _(string)_
    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.
  - **`native_type`** _(string)_
    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, key/value normalisation, or merging across providers. An empty object means no tags; unreadable tags appear in unreadable_fields instead.
  - **`collected_at`** _(string)_
    When Truto read this object from the provider, in UTC ISO 8601 with offset. Not the request time, and not a provider-supplied timestamp.
  - **`unreadable_fields`** _(array<object>)_
    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.
    - **`field`** _(string)_
      The property on this resource that could not be read.
    - **`reason`** _(string)_
      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.
      Allowed: `not_supported_by_provider`, `not_configured`, `permission_denied`, `not_collected`, `collection_error`, `partially_collected`, `available_on_get`
    - **`detail`** _(string)_
      Additional detail on the reason, when there is any.
  - **`remote_data`** _(object)_
    Raw data returned from the remote API call.
  - **`definition_id`** _(string)_
    The provider's own identifier for the policy or role definition.
  - **`name`** _(string)_
    The policy or role name as the provider names it.
  - **`is_custom`** _(boolean)_
    Whether the customer authored this, as opposed to a provider-supplied built-in.
  - **`allowed_actions`** _(array<string>)_
    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).
  - **`denied_actions`** _(array<string>)_
    Explicitly denied actions, with wildcards intact.
  - **`not_actions`** _(array<string>)_
    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.
  - **`not_resources`** _(array<string>)_
    Resources under a NotResource clause. Combined with Allow, this excludes these resources rather than including them.
  - **`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 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.
  - **`attachment_count`** _(integer)_
    How many principals this definition is attached to as a grant, kept separate from permissions_boundary_usage_count (a restriction, not a grant).
  - **`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())
```