ImmyBot icon

ImmyBot

ImmyBot Node
Join our community

Actions24

Overview

The node provides functionality to update a user within the ImmyBot system. It allows modifying user attributes such as admin privileges, tenant association, and management access rights. This is useful in scenarios where user roles or permissions need to be adjusted dynamically, for example, promoting a user to an admin role, changing their tenant affiliation, or toggling their ability to manage deployments.

Practical examples include:

  • Updating a user's admin status when they are promoted or demoted.
  • Changing the tenant ID if a user moves between organizational units.
  • Granting or revoking cross-tenant deployment management capabilities for non-admin users.

Properties

Name Meaning
Person ID (Optional) The unique identifier of the person to configure as a user.
Is Admin Whether the user should have administrative privileges (true/false).
Tenant ID The identifier of the tenant this user belongs to.
Can Manage Cross-Tenant Deployments For non-admin users, whether they can manage deployments across different tenants (true/false).
Has Management Access Whether the user has management access rights (true/false).

Output

The node outputs JSON data representing the updated user object after the operation completes. This typically includes the user's current properties reflecting any changes made, such as updated admin status, tenant ID, and access rights.

If the node supports binary data output, it would represent associated files or attachments related to the user, but based on the provided code and properties, the output is primarily JSON structured data.

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials to connect securely to the ImmyBot API.
  • The base URL for API requests is dynamically constructed using the subdomain from the credentials.
  • The node expects the ImmyBot API to be available at https://{subdomain}.immy.bot/api/v1.

Troubleshooting

  • Missing or invalid Person ID: Since the Person ID is required to identify which user to update, omitting it or providing an incorrect value will cause errors. Ensure the correct numeric ID is supplied.
  • Insufficient permissions: Attempting to update admin-related fields without proper authorization may result in permission errors. Verify that the API credentials have adequate rights.
  • Tenant ID mismatch: Providing an invalid or non-existent tenant ID could lead to failures. Confirm the tenant ID exists in the system.
  • API connectivity issues: Network problems or incorrect subdomain configuration can prevent successful API calls. Check network access and credential settings.
  • Boolean property misconfiguration: Properties like "Is Admin" and "Has Management Access" expect boolean values; passing other types might cause unexpected behavior.

Links and References

Discussion