Actions43
- Earning Types Actions
- Email Templates Actions
- Employee Types Actions
- Employees Actions
- Entities Actions
- Classes Actions
- Contacts Actions
- Department Groups Actions
- Exchange Rate Lines Actions
- Exchange Rate Types Actions
- Exchange Rates Actions
- Attachment Folders Actions
- Get Next Value Actions
- Location Groups Actions
- Locations Actions
- Roles Actions
- User Groups Actions
- Users Actions
- Affiliate Entity Groups Actions
- Attachments Actions
- Departments Actions
- Document Sequences Actions
Overview
This node operation creates a new user group within a company's configuration in the Sage Intacct system. User groups are collections of users that share common permissions and roles, simplifying permission management across multiple users. This operation is useful when setting up or modifying organizational structures, assigning access rights, or managing roles centrally.
Practical examples include:
- Creating a user group for the Accounts Payable department to manage invoice approvals.
- Defining a warehouse users group with specific roles related to inventory management.
- Setting up custom user groups for different teams to streamline role-based access control.
Properties
| Name | Meaning |
|---|---|
| Id | The unique name identifier of the user group (e.g., "AP" for Accounts Payable). |
| Description | A textual description of the user group explaining its purpose (e.g., "Accounts Payable"). |
| Additional Body Fields | Optional additional fields to include in the creation request: - Key: System-assigned unique key identifying the group. - Href: API endpoint URL for this user group. - Roles: JSON array listing roles assigned to the group; each role includes a key, id, and href. Roles define permissions inherited by all users in the group. - Audit: JSON object containing audit metadata such as creation and modification timestamps and user IDs. |
Output
The node outputs JSON data representing the newly created user group as returned by the Sage Intacct API. This typically includes the group's identifiers, description, assigned roles, and any metadata provided by the service.
If binary data were involved (not indicated here), it would represent files or attachments related to the user group, but this operation deals solely with JSON data.
Dependencies
- Requires an API key credential for authenticating with the Sage Intacct Company Configuration API.
- The base URL for the API must be configured in the node credentials.
- The node uses JSON-formatted requests and expects JSON responses from the API.
Troubleshooting
- Missing Required Fields: Errors may occur if mandatory properties like "Id" or "Description" are not provided. Ensure these fields are filled.
- Invalid JSON in Roles or Audit Fields: If the optional JSON fields are malformed, the API may reject the request. Validate JSON syntax before submission.
- Authentication Failures: Verify that the API key credential is correctly set up and has sufficient permissions.
- API Endpoint Issues: Incorrect base URL or network issues can cause connection errors. Confirm the API endpoint is reachable.
- Duplicate User Group Ids: Attempting to create a user group with an existing Id might result in conflicts. Use unique identifiers.