Search Users

Retrieve users in the account.

Options

Field Definition Type Required

Result Set

Choose a method to filter search results:

  • First Matching Record: Returns the first record that matches.

  • First 100 Matching Records: Returns the first 100 matching records.

  • Stream Matching Records: Passes all matching records from your parent flow to a helper flow.

    Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add custom extensible fields.

Dropdown FALSE

Input

Field Definition Type Required

Search Criteria

First Name

Given name of the user.

Text FALSE

Last Name

Last name of the user.

Text FALSE

Email

The email address of the user.

Text FALSE

State

The state of the user.

 Text FALSE

Substate

The substate of the user.

 Text FALSE

IAM ID

A unique identifier of the IBM cloud account. It can be IBMid, service ID, or trusted profile ID.

 Text FALSE

Realm

The realm of the user. The value is either IBMid, BSS, or SL.

 Text FALSE

Streaming

Flow

Click Choose Flow to select a helper flow. Search results will be streamed to this flow. Then, click Choose to confirm.

Optionally, add custom fields to pass data to the helper flow. Click the empty field under Click or drop here to create these fields. They appear as key/value pairs in the helper flow's State output object.

This option is available only when you select Stream Matching Records from the Result Set option.

In the helper flow, the input field on the helper card must reference a State Record key to get the streamed records. To get your custom input values, reference the State key within the State object.

Flow

 TRUE

Record Limit

Specify the number of records to stream.

  • The Record Limit field can't be set to 0. When the Record Limit field is set to greater than 1, the stream returns up to the maximum number specified.
  • When the Record Limit field is null or not selected, the stream returns all records.
  • The default value is 500000.
  • The valid range is from 1 to 500000.

This field appears when you select Stream Matching Records from the Result Set option.

 Number FALSE

Output

Field Definition Type

Result

ID

Unique identifier of the user.

Text

IAM ID

A unique identifier of the IBM cloud account. It can be IBMid, service ID, or trusted profile ID.

 Text

Realm

The realm of the user. The value is either IBMid or SL.

 Text

User ID

The user ID used for login.

 Text

First Name

Given name of the user.

Text

Last Name

Last name of the user.

Text

State

The state of the user.

 Text

Email

The email address of the user.

Text

Phone Number

User's phone number.

Text

Alternative Phone Number

The alternative phone number of the user.

 Text

Photo

A link to a photo of the user.

 Text

Account ID

An alphanumeric value identifying the account ID.

 Text

Added On

The timestamp for when the user was added to the account.

 Text

Total Count

Total number of records

 Number

Users

An object with information about users. List of Objects

ID

Unique identifier of the user.

Text

IAM ID

A unique identifier of the IBM cloud account. It can be IBMid, service ID, or trusted profile ID.

 Text

Realm

The realm of the user. The value is either IBMid or SL.

 Text

User ID

The user ID used for login.

 Text

First Name

Given name of the user.

Text

Last Name

Last name of the user.

Text

State

The state of the user.

 Text

Email

The email address of the user.

Text

Phone Number

User's phone number.

Text

Alternative Phone Number

The alternative phone number of the user.

 Text

Photo

A link to a photo of the user.

 Text

Account ID

An alphanumeric value identifying the account ID.

 Text

Added On

The timestamp for when the user was added to the account.

 Text

Records Streamed

Number of records streamed in a streaming flow.

This field appears when you select Stream Matching Records from the Result Set option.

 Number