Directus (flagbit) icon

Directus (flagbit)

Consume Directus API

Actions118

Permission → Create

AI-generated

Overview

This node creates a permission rule for a specified collection in a system that manages permissions. It is useful for automating the setup of access control by defining what CRUD (Create, Read, Update, Delete) operations are allowed on particular collections. For example, it can be used to grant create permissions on a 'customers' collection to certain users or roles.

Use Case Examples

  1. Automate permission setup for new collections in a database.
  2. Define specific CRUD permissions for different user roles programmatically.

Properties

Name Meaning
Collection Name Specifies the collection to which the permission applies. This is a required field and is selected from available collections via a load options method.
Action Defines the CRUD operation that the permission rule applies to. Options include create, read, update, and delete. This is a required field.
JSON/RAW Parameters Determines whether the body parameters are set via a UI with value-key pairs or directly as JSON/RAW input. This is a required boolean field.
Body Parameters The body parameters for the permission creation request, provided as JSON or RAW input. This is required when JSON/RAW Parameters is true.

Output

JSON

  • permissionId - The unique identifier of the created permission.
  • collection - The collection to which the permission applies.
  • action - The CRUD action that the permission allows.
  • details - Additional details about the created permission.

Dependencies

  • Requires an API key credential or similar authentication to interact with the permissions API.

Troubleshooting

  • Ensure the collection name is valid and exists in the system; otherwise, the permission creation will fail.
  • Verify that the action is one of the allowed CRUD operations: create, read, update, or delete.
  • If using JSON/RAW parameters, ensure the JSON is well-formed and matches the expected schema for permission creation.
  • Common errors include authentication failures, invalid collection names, or malformed JSON input. Check API credentials and input data format.

Discussion