Deactivate User Smart Service

Overview

The Deactivate User smart service allows you to select an existing user and disable them from the system. Deactivated users are still present in the system, but will not be able to log in. You must be a System Administrator or the Administrator user account in order to perform this task.

Caution: The Deactivate User node can only be run with System Administrator rights. Attempting to run this node without sufficient user rights causes a runtime exception that pauses the process and sends an alert to the Process Administrator.

The Administrator user account cannot be deactivated using this smart service.

The Deactivate User node is located under Appian Smart Services > Identity Management in the Process Modeler Palette.

Properties

Category: Identity Management
Icon:
Assignment Options: Attended/Unattended

Configuration options

This section contains tab configuration details specific to this smart service. For more information about common configurations see the Process Node Properties page.

Data tab

The Data tab displays the node inputs and node outputs for the service node. You can add additional inputs and outputs, if needed.

Node inputs

The default input is:

Input	Data Type	Required	Multiple
User	User	Yes	No

a!deactivateUser()

The Deactivate User smart service is available as an expression function that can be executed inside a saveInto parameter on an interface component or as part of a Web API.

Syntax

a!deactivateUser( user, onSuccess, onError )

Parameters

Keyword	Type	Description
`user`	User	The user to deactivate.
`onSuccess`	Any Type	A list of saves or an HTTP response to execute after the smart service executes successfully. Created with `a!save()` or `a!httpResponse()`.
`onError`	Any Type	A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with `a!save()` or `a!httpResponse()`.

Feature compatibility

The table below lists this smart service function's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Partially compatible	Can be used with Appian Portals if it is connected using an integration and web API.
Offline Mobile	Incompatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.

Feedback

Was this page helpful?