HumHub icon

HumHub

Consume HumHub API (v.0.1.8)

Actions126

Overview

This node operation creates a new group in the HumHub platform via its API. It is useful for automating the management of user groups within HumHub, such as setting up new groups for different teams, departments, or interest areas. For example, an organization can use this node to programmatically create groups with specific names, descriptions, and visibility settings to streamline user management and access control.

Use Case Examples

  1. Creating a new group named 'Marketing Team' with a description and making it visible in the directory and selectable at registration.
  2. Automating the creation of multiple groups with different sort orders to organize them in a specific sequence within the HumHub directory.

Properties

Name Meaning
Authentication Method of authentication to use for the API request, either Basic Auth or JWT Token.
Name The name of the group to be created.
Description A textual description of the group.
Show At Directory Boolean flag to indicate if the group should be shown in the directory.
Show At Registration Boolean flag to indicate if the group should be selectable during user registration.
Sort Order A numeric value between 0 and 10000 to determine the group's order in listings, typically using steps of 100.

Output

JSON

  • id - Unique identifier of the created group.
  • name - Name of the created group.
  • description - Description of the created group.
  • show_at_directory - Indicates if the group is shown in the directory.
  • show_at_registration - Indicates if the group is selectable at registration.
  • sort_order - Sort order value of the group.

Dependencies

  • HumHub API

Troubleshooting

  • Ensure that the authentication credentials (Basic Auth or JWT Token) are correctly configured and valid, as authentication failures will prevent group creation.
  • Verify that the 'Name' property is provided and not empty, since it is required for creating a group.
  • Check the API endpoint availability and network connectivity to HumHub, as network issues can cause request failures.
  • If the API returns validation errors, review the input values for 'Sort Order' to ensure they are within the allowed range (0 to 10000).

Links

Discussion