Get Users (Okta) activity

An activity that retrieves one or more users from Okta.


Get Users activity

Configure the Get Users activity

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Okta tab.

    Open Okta tab
  3. On the Okta tab, drag the Get Users activity onto your process.

    Drag Get Users activity

General Configuration

Specifies the basic settings for the Get Users activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts 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

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Get Users Configuration

Specifies the information to retrieve one or more users from Okta.

Figure: Get Users Configuration screen

Get Users Configuration screen

Fields

Field NameDefinition

Okta

Description:
Specifies the access token that connects to your Okta service.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

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

Order By

Description:
Specifies the sort order for the Okta users.
Allowed Values:
  • ASC - Sorts the users in ascending order.
  • DESC - Sorts the users in descending order.
Default Value:
ASC
Accepts Variables:
No

Sort By

Description:
Specifies the user property to sequence how the Okta users show on the query result.
Allowed Values:
A user property name from the list.

When you select the access token from the Okta field, this field shows the user property names associated with the access token.

Default Value:
None

Row Limit

Description:
Specifies the maximum number of users to retrieve from Okta.
Allowed Values:
An integer.

Range

  • 1-10000
Default Value:
10,000
Accepts Variables:
No

Filter

Function:
Shows the code snippet that is created when you configure the filter condition for your query.

You can configure the filter condition on the Get Users Configuration > Create Conditions screen.

Allowed Values:
Read only.
Default Value:
None

Create Create icon

Opens this Screen:
Get Users Configuration > Create Conditions
Function of this Screen:
Specifies a filter condition to retrieve information about one or more users from Okta.

Delete Delete icon

Function:
Deletes the query from the code snippet.

Edit Edit icon

Function:
Lets you change the query.

Response Mapping

Description:
Maps information about the user from the Okta data model to your process schema.
Allowed Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the response to the data model for your process.

Because the query can return more than one result, the parent node in the external data source must be mapped to a node in the AgilePoint NX process schema that is a repeating schema element. The child nodes in both data models must also be mapped, but child nodes in AgilePoint NX inherit the repeating behavior from their parent node.

Default Value:
None
Example:
Refer to:

Get Users Configuration > Condition Builder screen

Specifies a filter condition to retrieve information about one or more users from Okta.

Figure: Get Users Configuration > Condition Builder screen

Get Users Configuration Condition Builder screen

Fields

Field NameDefinition

Field Name

Description:
Specifies the name of the user property from Okta to use in your query.
Allowed Values:
A user property name from the list.

When you select the access token from the Okta field, this field shows the user property names associated with the access token.

Default Value:
None
Accepts Variables:
No
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Operator

Description:
Specifies the operator to use in your query.
Allowed Values:
  • =
  • !=
  • >=
  • >
  • <
  • <=
  • starts with
  • has value
Default Value:
=

Field Value

Description:
Specifies the value for the user property.
Allowed Values:
One line of text (a string) that can have letters, numbers, spaces, and special characters.
Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Add Row

Function:
Adds a row for the Field Name and Field Value.

Select Nest Type

Function:
Specifies the use of logical AND and OR operators to nest conditions to filter the Okta users.

You must set the condition first, before you specify the nest type.

Allowed Values:
  • And - Specifies the logical AND operator.
  • Or - Specifies the logical OR operator.
Default Value:
Or

Indent Right Indent Right icon

Function:
Creates the statement that is a condition of a parent statement.

Delete Delete icon

Function:
Deletes the selected row.

Back Back icon

Function:
Saves the rule and goes back to the Create Condition screen.