Axonius - Deactivate User

Axonius - Deactivate User deactivates Axonius users for:

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

Users are deactivated and given a status of "Inactive". See Managing User Status.

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

Not all asset types are supported for all Enforcement Actions.

See Actions supported for Activity Logs, Adapters Fetch History, and Asset Investigation modules.

See Actions supported for Aggregated Security Findings.

See Actions supported for Software.

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 Axonius Users 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.
  
  📘
  To use this option, you must successfully configure a Axonius Users adapter connection.
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.

Axonius Domain - The URL of the Axonius instance in which you want to deactivate the user.

API Key - The API key of the account used to access the Axonius instance.

API Secret - The API Secret of the account used to access the Axonius instance..

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 Password (optional) - The password to use when connecting to the server using the HTTPS Proxy.

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

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

Required Permissions

Choose one of these snippets:

The stored credentials, or those provided in Connection and Credentials, must have the necessary permissions to perform this enforcement action.

Updated 10 months ago

Did this page help you?