Directus (flagbit) icon

Directus (flagbit)

Consume Directus API

Actions118

Permission → List

AI-generated

Overview

This node operation lists permissions from a data source, allowing users to retrieve either all permissions or a limited number based on specified criteria. It supports advanced filtering, sorting, grouping, and aggregation of permission data, making it useful for scenarios where detailed permission analysis or export is needed, such as auditing user access or generating reports.

Use Case Examples

  1. Retrieve all permissions without limit for a comprehensive audit.
  2. Fetch a limited number of permissions with specific filters and sorting to analyze recent changes.
  3. Export permission data in CSV format for external reporting or backup.

Properties

Name Meaning
Return All Determines whether to return all permission results or limit the number of results.
Limit Specifies the maximum number of permission results to return when not returning all.
Split Into Items Indicates whether to output each element of an array as its own item.
JSON/RAW Parameters Specifies whether query and/or body parameters should be set via UI or JSON/RAW input.
Body Parameters Body parameters provided as JSON or RAW input for the request.
Additional Fields Additional optional fields to customize the request, including aggregation functions, export options, filtering, sorting, grouping, and metadata.

Output

JSON

  • permissions - Array of permission objects returned from the list operation.
  • exportFile - File containing exported permission data if export option is used.

Dependencies

  • Requires connection to a Directus API endpoint with appropriate authentication credentials.

Troubleshooting

  • Ensure the API credentials are correctly configured to avoid authentication errors.
  • Check that the 'Limit' value is within the allowed range (1-100) when 'Return All' is false.
  • Validate JSON input in 'Body Parameters' and 'Filter' fields to prevent parsing errors.
  • If export fails, verify that the file name and format are correctly specified.

Discussion