avanta icon

avanta

Consume avanta API

Actions57

Company - Rule → Create or Update

AI-generated

Overview

This node handles the creation or updating of company rules within the Avanta API. It is useful for managing permissions and roles associated with companies, such as setting access controls or defining specific rules for company roles. For example, it can be used to assign an external role ID to a company resource with a specified permission (allow or deny).

Use Case Examples

  1. Creating a new company rule to allow a specific external role access to a company resource.
  2. Updating an existing company rule to deny access for a certain role.

Properties

Name Meaning
Request Options Options to customize the API request such as enabling debug mode, ignoring SSL issues, and setting a timeout period.
External Role ID The external role ID associated with the company rule, required for identification.
Resource ID The resource ID for the company rule, required to specify the target resource.
Permission The permission setting for the company rule, either 'Allow' or 'Deny'.

Output

JSON

  • response - The API response data after creating or updating the company rule.

Dependencies

  • Requires an API key credential for authenticating with the Avanta API.

Troubleshooting

  • Ensure that the required fields 'External Role ID', 'Resource ID', and 'Permission' are provided; missing these will cause errors.
  • If SSL issues occur, consider enabling 'Ignore SSL Issues' option, but be aware of security risks.
  • Timeout errors may occur if the server is slow to respond; increase the timeout setting if needed.

Discussion