Search Users

Search for users in SAP Analytics Cloud.

Options

Field Definition Type Required

Result Set

Specify how you want to have the results returned:

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

  • First Matching 200 Records: Returns the first 200 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 TRUE

Filter

Choose one of the following filter options to search for users where the selected attributes match:

  • Contains: The selected attributes contain the provided values.

  • Equal: The selected attributes are equal to the provided values.

  • Not Equal: The selected attributes aren't equal to the provided values.

  • Starts With: The selected attributes start with the provided values.

  • Ends With: The selected attributes end with the provided values.

Dropdown FALSE

Input

Field Definition Type Required

Search By

Email

The email address of the user.

 Text FALSE

Username

The username of the user.

 Text FALSE

Custom

Filter

To make your search more flexible, provide a user API attribute name with a filter operator.

  • If you use the Custom Filter field with other input fields, its value must start with the AND or OR logical operator.

  • If you only use the Custom Filter field, its value can't start with the AND or OR logical operator.

See the Supported API attributes and Operators for a full list of available attributes and filter operators.

 Text FALSE

Streaming

Flow

Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm.

Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow.

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

 TRUE

Record Limit

Specify the number of records to stream.

  • When the Record Limit field is set to greater than 0, the stream returns up to the maximum number specified.

  • When the Record Limit field is null or not selected, all records are streamed.

  • The default value is 1000000 (1 million).

  • The valid range is from 1 to 1000000.

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

 Number FALSE

Output

Field Definition Type

Result

ID

The unique identifier of the user.

 Text

Username

The username of the user.

 Text

Email

The email address of the user.

 Text

First Name

The first name of the user.

 Text

Last Name

The last name of the user.

 Text

Display Name

The display name of the user.

 Text

Enterprise

Object

Manager ID

The ID of the enterprise manager.

 Text

Roles

The roles of the user.

 List of Text

Is Active

If this is set to true, it specifies that the user is active.

 True/False

Teams

List of Objects

Name

The name of the team.

 Text

Description

The description of the team.

 Text

Photos

The photo URL of the user.

 List of Text

Preferred Language

The language to view SAP Analytics Cloud.

 Text

Custom Attributes

Object

Data Access Language

The default language for displaying stories created from live data connections.

 Text

Date Formatting

The display format of the date.

 Text

Time Formatting

The display format of the time.

 Text

Number Formatting

The display format of numbers.

 Text

Clean Up Notifications

The number of days after which you want the system to delete notifications.

 Number

System Notifications

If this is set to true, an email is sent to the user with information about the system activities. For example, when a new password is set.

 True/False

Product Updates and Learning

If this is set to true, an email is sent to the user with information about product updates and learning opportunities.

 True/False

Is Concurrent

If this is set to true, it specifies that the user has a concurrent license.

 True/False

Meta

Object

Created At

The date and time when the team was created.

 Date & Time

Resource Type

The type of resource. The value is set to User.

 Text

Raw Output

The raw output returned by the SAP Analytics Cloud API.

 Object

Records Streamed

The number of records streamed in a streaming flow.

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

 Number