Does User Exist activity

An activity that is used to check whether a user exists in Active Directory.


Does User Exist activity

Configure the Does User Exist activity

To configure the Does User Exist activity, do the procedure in this topic.

Prerequisites

Good to Know

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Active Directory Active Directory icon tab.
      2. On the Active Directory Active Directory icon tab, drag the Does User Exist Does User Exist icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Does User Exist activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Does User Exist Configuration

Configures the user check in Active Directory.

Figure: Does User Exist Configuration screen

Does User Exist Configuration screen

Fields

Field Name Definition

Active Directory

Function:
Specifies the access token that connects to your Active Directory.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No

Add Token Add Token icon

Opens this Screen:
Access Token for Active Directory.
Function of this Screen:
Configure an access token to connect to Active Directory.

User Name

Function:
Specifies the name of a user to check if the user exists in Active Directory.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
Yes

Group Name

Function:
Specifies the name of the Active Directory group.
Accepted Values:
A valid Active Directory group name.

When you select the access token from the Active Directory field, a list of group names shows in this field.

Default Value:
None
Accepts Process Data Variables:
Yes

Store the Response in Custom Attribute or Schema

Function:
Specifies a process data variable that stores a Boolean value of true or false.

Returns true if the user exists in Active Directory, false if not.

Accepted Values:
A process data variable that accepts a Boolean value, or the text true or false.
Default Value:
None
Accepts Process Data Variables:
Yes