Remove Group Members Smart Service

Overview

The Remove Group Members node allows you to select a user within a group, and remove that user from the group. You must be either a System Administrator or a Group Administrator in order to run this node.

The Remove Group Members Service Node can only be executed by someone with Group or System Administrator rights. Attempting to complete this task without sufficient user rights causes a runtime error message to be sent to the Process Administrator and pauses the process.

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

This 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 inputs are:

Input Data Type Required Multiple
Choose Members People Yes Yes
Group Group Yes No

If the node is run without being assigned to a user (or a group) you must specify values for each of the Node Inputs listed in the table above. You can either manually enter data into the text-field, or a value can be generated using the Expression Editor. When using the Expression Editor, you can reference and modify Process Variables, rules, constants, and other data. The expressions then populate your Node Input values.

If the node is assigned, the Node Input values are typed by your assigned user(s) into a form.

Node outputs

This node does not return any values.

a!removeGroupMembers()

The Remove Group Members smart service is available as an expression function that can be executed inside a saveInto on a Interface Component or as part of a Web API.

Syntax

a!removeGroupMembers(group, members, onSuccess, onError)

Parameters

Keyword Type Description

group

Group

The users to remove as members of this group.

members

List of User or Group

The users that will be removed as members.

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().

Open in Github Built: Fri, Sep 17, 2021 (04:05:09 PM)

On This Page

FEEDBACK