List Users

Retrieve a list of all users in KnowBe4.

Other user fields can be added to the output section using extensible fields. When you add a field by its corresponding API field name, the card returns the field as an output.

Options

Field	Definition	Type	Required
Result Set	Choose a method to filter search results: First 200 Records: Returns the first 200 matching records. Stream Records: Passes all matching user 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
Expand Groups	Choose one of the following options to return your results: Yes: Returns full information about user groups. No: Returns only the ID of user groups.	Dropdown	TRUE

Field

Definition

Type

Required

Result Set

Choose a method to filter search results:

First 200 Records: Returns the first 200 matching records.
Stream Records: Passes all matching user 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

Expand Groups

Choose one of the following options to return your results:

Yes: Returns full information about user groups.
No: Returns only the ID of user groups.

Dropdown

TRUE

To learn how to return large numbers of records, see Stream matching records with a helper flow.

Input

Field	Definition	Type	Required
Filters
Status	Status of the users you're searching for. Select one of the following values: Active Archived All	Dropdown	FALSE
Group ID	Unique identifier of the group.	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 option. The input field on the Helper Card in the streaming helper flow must reference the key Record (type object) to obtain streamed records. To obtain state input values, reference the key State (type object) of the Record object.	Flow	TRUE
Record Limit	Specify the number of records to stream. When the Record Limit field is set, a value of 0 isn't allowed. 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 empty, null, or not selected, the stream returns all records. The default value is 2500000. The valid range is from 1 to 2500000. This field appears when you select Stream Records from the Result Set option.	Number	FALSE

Output

Field	Definition	Type
Result
Users		List of Objects
ID	Unique identifier of the user.	Number
Employee Number	Employee number of the user.	Text
First Name	Given name of the user.	Text
Last Name	Family name of the user.	Text
Job Title	Job title of the user.	Text
Email	The email address of the user.	Text
Phish Prone Percentage	Phish-prone percentage of the user.	Number
Phone Number	The phone number of the user.	Text
Extension	Phone extension of the user.	Text
Mobile Phone Number	The mobile phone number of the user.	Text
Location	Location of the user.	Text
Division	Division of the user.	Text
Manager Name	Name of the user's manager.	Text
Manager Email	Email address for the manager.	Text
Is Provisioning Managed	If enabled, indicates whether Active Directory manages the user. The default is true.	True/False
Provisioning GUID	Provisioning GUID of the user.	Text
Groups	A list of group IDs where the user is a member.	List of Objects
ID	Unique group identifier.	Number
Name	Name of the group.	Text
Type	Indicates the group type.	Text
Provisioning GUID	User provisioning GUID, if applicable.	Text
Members Count	Number of members in the group.	Number
Group Risk Score	Current risk score for the group.	Number
Status	Status of the group.	Text
Organization Risk Score	The current risk score of the organization.	Number
Email Aliases	A list of alias email addresses for the user. These are imported from Active Directory.	List of Text
Created	The date the user was added to the KnowBe4 account.	Date & Time
Last Login	The date the user last signed in to their KnowBe4 account.	Date & Time
Status	Status of user (either active or archived).	Text
Organization	Organization of the user.	Text
Department	Department of the user.	Text
Language	Language of the user.	Text
Comment	Any comments indicated in the user profile.	Text
Employee Start Date	The start date of the user.	Date & Time
Archived At	If applicable, the date the user was archived in the KnowBe4 console.	Date & Time
Custom Field 1	Custom text field for the user.	Text
Custom Field 2	Custom text field for the user.	Text
Custom Field 3	Custom text field for the user.	Text
Custom Field 4	Custom text field for the user.	Text
Custom Date 1	Custom date field for the user.	Date & Time
Custom Date 2	Custom date field for the user.	Date & Time
Records Streamed	Number of records streamed in a streaming flow. This field appears when you select Stream Records from the Result Set option.	Number

List Users

Options

Input

Output

Related topics