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

Smartsheet - Suspend user

Smartsheet - Suspend user deactivates Smartsheet users 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 Smartsheet 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 Smartsheet adapter connection.

Note

The action uses the Smartsheet user ID stored on each user asset. The action fails for users that do not have a user ID.

Additional Fields

This Enforcement Action does not have additional optional fields.

Connection Settings

💡

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.

Select stored Smartsheet adapter credentials, or provide the following connection settings when you do not use stored credentials:

  • Token - The Smartsheet API access token of a user that has the Required Permissions to perform this action.

  • 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 Smartsheet API - POST /users/USERID/deactivate

Required Ports

Axonius must be able to communicate via the following ports:

  • TCP port 443

Required Permissions

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

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

The following permissions and requirements are needed:

  • The API access token must belong to a Smartsheet user with the System Admin role.
  • Users managed by an external identity provider or directory integration cannot be deactivated through the Smartsheet API. Deactivate these users in the external source instead.
  • Users whose primary email address is on a consumer email domain, or is not part of the Smartsheet plan's domains, cannot be deactivated.
  • This API is not available for Smartsheet Gov accounts.

Version Matrix

This Enforcement Action was tested only with the versions marked as supported, but may work with other versions. Please contact Axonius Support if you have a version that is not listed and it is not functioning as expected.

VersionSupportedNotes
Smartsheet API 2.0YesUses /users/USERID/deactivate.

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

Updated 13 days ago

Did this page help you?