Search Users

Search for Opsgenie users based on the properties specified in the search parameter.

Options

Field	Definition	Type	Required
Result Set	Choose one of the following options to display your search results: First Matching Record: returns the first matching group rule. Stream Matching Records: pasess all matching records from your parent flow to a helper flow; a Streaming input section will be added to the card from which you can select a helper flow for streaming and adding custom extensible fields.	Dropdown	TRUE
Use Custom Query	Indicates if the user selected a custom query. Available values are Yes and No.	Dropdown	TRUE

Custom Query and Result Set Options

When the Custom Query String? option is set to Yes and the Result Set is set to Streaming Matching Records, the following input fields display:

• Custom Query

• Sort by

• Sort Order

• Flow

Other combinations of Custom Query String? and Result Set settings will result in different Input and Output fields. These fields and their definitions are listed below.

Input

Field	Definition	Type	Required
Username	Email address of the user.	Text	FALSE
Full name	Combination of the name and the surname of a user.	Text	FALSE
Blocked	Indicates if a user is blocked due to a subscription update. Available values are true and false.	Dropdown	FALSE
Verified	Indicates if a user is verified. Available values are true and false.	Dropdown	FALSE
Role	Name of the role assigned to the user. These roles are dynamically generated based on custom roles the user has created. For example, admin, user or the name of a custom role.	Text	FALSE
Locale	Location information of the user. If not set, locale of the customer is used instead.	Text	FALSE
Time Zone	Timezone of the user. If not set, timezone of the customer will be used instead.	Dropdown	FALSE
Address Line	Address of the user.	Text	FALSE
City	Country of the user.	Text	FALSE
State	State address of the user.	Text	FALSE
Country	Country of the user.	Text	FALSE
Zip Code	Zip Code of the user's address.	Text	FALSE
Sort by	Displays a dropdown list of options: Username, Full Name, Created At	Dropdown	FALSE
Sort order	Sort column by Ascending or Descending order.	Dropdown	FALSE
Streaming
Flow	Displays if Result Set is set to Stream Matching Records.	Flow	TRUE
Custom Query	Specify any additional query parameters that should be included in object format (key value pairs). Displays if User Custom Query? set to Yes. See Use Search Queries.	Text	FALSE

Output

Field	Definition	Type
Blocked	Displays if a user is blocked due to a subscription update. Available values are true and false.	True/False
Verified	Boolean flag that shows if a user is verified. Available values are true and false.	True/False
User ID	Unique identifier of the user.	Text
Email Address	Email address of the user.	Text
Full Name	Combination of the name and the surname of a user.	Text
Role	Name of the role assigned to the user. These roles are dynamically generated based on custom roles the user has created. For example, admin, user or the name of a custom role.	Text
Time Zone	Timezone of the user. If not set, timezone of the customer will be used instead. You can refer to Supported Timezone IDs.	Text
Locale	Location information of the user. If not set, locale of the customer is used instead. See Supported Locale IDs for available locales.	Text
Address Line	Line address of the user.	Text
City	City of the user.	Text
State	State address of the user.	Text
Country	Country of the user.	Text
Zip Code	Zip Code of the user's address.	Text
Details	Set of user defined properties.	Text
Created At	Date and time when the object was created.	Date & Time
Contact Information	Defines contact methods that are available to a user.	Array of Objects
Custom Details	Displays a set of user defined properties.	Object
Tags	List of labels attached to the user. You can label users to differentiate them. For example, you can add ITManager tag to differentiate people with this role from others.	Arrays of Strings

Related topics

Opsgenie connector

Workflow elements

Opsgenie API overview