Axonius Documentation
  1. Enforcement Action Library
  2. Manage Users and User Groups

Hyland OnBase - Assign Group to User

Hyland OnBase - Assign Group to User assigns a user group to users in Hyland OnBase for:

  • Assets returned by the selected query or assets selected on the relevant asset page.

See Creating Enforcement Sets to learn more about adding Enforcement Actions to Enforcement Sets.

When accessing an enforcement action using the API, you must use the backend form of field names.

Use the Syntax Helper to find the correct name. In the enforcement action, enable Configure Dynamic Values and select Syntax Helper.

📘

Note

Required Fields

These fields must be configured to run the Enforcement Action.

  • Action name - The name of this Enforcement Action. The system sets a default name. You can change the name.
  • Configure Dynamic Values (optional) - Toggle on to enter a Dynamic Value statement. See Creating Enforcement Action Dynamic Value Statements to learn more about Dynamic Value statement syntax.

  • Use stored credentials from the Hyland OnBase adapter - Select this option to use credentials from the adapter connection. By default, the first connection is selected.

    • When you select this option, the Select Adapter Connection drop-down becomes available. Select the adapter connection to use for this Enforcement Action.

      📘

      Note

      To use this option, you must successfully configure a Hyland OnBase adapter connection.

  • Group ID - The ID of the user group to assign to the user.

  • Compute Node - The Axonius node to use when connecting to the specified host. For more details, see Working with Axonius Compute Nodes.

Additional Fields

These fields are optional.

⚠️

Connection and Credentials

When Use stored credentials from the adapter is toggled off, some of the connection fields below are required to create the connection, while other fields are optional.

  • Host Name or IP Address - The base domain for the Hyland OnBase API. Should contain a prefix of http:// or https://. Do not add any specific endpoints after the domain. Example: https://www.hyland-onbase.com/
  • API Key - Bearer token for authentication with the OnBase Administration API.

  • Verify SSL (Optional) (default: enabled) - Selects whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings. This setting is enabled by default on all new adapter settings. If you need to disable SSL verification, make sure you disable this setting.)

  • HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.

  • HTTPS Proxy User Name (optional) - The user name to use when connecting to the server using the HTTPS Proxy.

  • HTTPS Proxy Password (optional) - The password to use when connecting to the server using the HTTPS Proxy.

  • Gateway Name - Select the Gateway through which to connect to perform the action.

APIs

Axonius uses the Hyland OnBase Administration API - PUT /api/users/user-groups

Required Ports

Axonius must be able to communicate via the following ports:

  • TCP port 80/443

Required Permissions

The stored credentials, or those provided in Connection and Credentials, must have the following permission(s) to perform this Enforcement Action:

  • The API key must have administrative access to read and modify user and group data
  • Permissions to access the OnBase Administration API endpoints for user management
  • Ability to assign users to user groups via the API

For more details about other enforcement actions available, see Action Library.

Updated 4 months ago

Did this page help you?