Shopware icon

Shopware

Shopware

Actions778

Acl Role → Update Acl Role

AI-generated

Overview

This node operation updates an ACL (Access Control List) Role in the Shopware system. It allows users to modify properties of an ACL Role such as its identifier, name, description, privileges, associated users, timestamps, and related app and integration data. This operation is useful for managing user permissions and roles within a Shopware environment, ensuring that access controls are kept up to date according to organizational needs.

Use Case Examples

  1. Updating the name and privileges of an existing ACL Role to reflect new access policies.
  2. Modifying the users associated with an ACL Role to grant or revoke permissions.
  3. Changing the description or timestamps of an ACL Role for record-keeping or auditing purposes.

Properties

Name Meaning
Id Identifier for the ACL Role to update, required to specify which role to modify.
Response Data format for the response, used to specify how the response data should be formatted or filtered.
Name The new name for the ACL Role, required to update the role's name.
Description A description for the ACL Role, providing additional context or details about the role.
Privileges A JSON array representing the privileges assigned to the ACL Role, defining what actions the role can perform.
Deleted At Timestamp indicating when the ACL Role was deleted, if applicable.
Created At Timestamp indicating when the ACL Role was created.
Updated At Timestamp indicating when the ACL Role was last updated.
Users A JSON array of users associated with the ACL Role, representing which users have this role assigned.
App A JSON object representing the app data related to the ACL Role, including modules, integrations, and other app-specific configurations.
Integrations A JSON array representing integrations related to the ACL Role, including associated notifications and app data.

Output

JSON

  • id - The identifier of the updated ACL Role.
  • name - The updated name of the ACL Role.
  • description - The updated description of the ACL Role.
  • privileges - The updated privileges assigned to the ACL Role.
  • deletedAt - The deletion timestamp of the ACL Role, if set.
  • createdAt - The creation timestamp of the ACL Role.
  • updatedAt - The last updated timestamp of the ACL Role.
  • users - The users associated with the ACL Role.
  • app - The app data related to the ACL Role.
  • integrations - The integrations related to the ACL Role.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the 'Id' property is correctly set to the ACL Role you want to update; otherwise, the update will fail or affect the wrong role.
  • Privileges and users must be valid JSON arrays; invalid JSON will cause errors.
  • Check API credentials and permissions to ensure the node can perform update operations on ACL Roles.
  • Timeouts or network issues may cause the request to fail; adjust timeout and proxy settings if necessary.

Discussion