Search User

Search for a user in G Suite.

Unless otherwise indicated, field types are text.

Options

  • Return

    • First matching user: first user record to match search criteria

    • All matching users: all user records that match search criteria

Input

  • Search By

    • Name: name of the user

    • Email: email address of the user

    • First Name: user's first name

    • Last Name: user's last name

    • Is Admin?(boolean): indicator if the user has super admininistrator privileges (this field can only be edited in the Make User Admin action)

    • Is Delegated Admin?(boolean): indicator if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the Admin console.

    • Is Suspended? (boolean): indicator if the user is suspended

    • IM Network ID: user's IM accounts (user may have multiple IM accounts, but only one primary)

    • External ID: value of the ID

    • Manager Email: email address of the user's manager

    • Manager ID: unique identifier of the user's manager

    • Direct Manager Email: email address of the user's direct manager

    • Direct Manager ID: unique identifier of the user's direct manager

    • Address: user's address

    • Address Street: street portion of the user’s address

    • Address PO Box: user’s post office box

    • Address City: user’s city of residence

    • Address Region: user’s geographic region

    • Address Postal Code: zip or postal code of the user’s address

    • Address Country: user’s country of residence

    • Organization Name: name of the organization

    • Organization Department: department in the organization that the user is associated with (for example, sales or engineering)

    • Organization Description: description of the organization

    • Organization Cost Center: cost center of the user's organization

    • Phone: phone number of the organization

    • Parent Organization Path: full path of the parent organization associated with the user (if the parent organization is the top-level, it is represented as a forward slash)

    • Is Enrolled in 2SV?(boolean): indicator if user enrolled in 2-step verification

    • Is Enforced in 2SV?(boolean): indicator if user is 2-step verification enforced

    • Custom Schema Name: custom schema for the user

    • Custom Field Name: custom fields for the user

    • Custom Field Value: custom field values for the user

Output

  • Users

    • User ID: unique identifier of the user

    • ETag: ETag of the resource

    • First Name: user's first name

    • Last Name: user's last name

    • Full Name: user's full name

    • Notes: notes for the user

    • Is Admin?(boolean): indicator if the user has super administrator privileges (this field can only be edited in the Make a User an Administrator action)

    • Is Delegated Admin?(boolean): An indicator if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the Admin console.

    • Change Password At Next Login?(boolean): indicator if the user is forced to change their password at next login (does not apply when SSO is configured with a third party identity provider)

    • Agreed to Terms? (boolean): indicator if the user has completed an initial login and accepted the Terms of Service agreement

    • IP Allow Listed? (boolean): indicator if the user's IP address is allow listed

    • Suspended? (boolean): indicator if the user is suspended

    • Suspension Reason: reason that the user is suspended by either the administrator or by Google at the time of suspension; options are ABUSE, ADMIN, UNDER13, or WEB_LOGIN_REQUIRED

    • Parent Organization Path: full path of the parent organization associated with the user (if the parent organization is the top-level, it is represented as a forward slash)

    • Customer ID: customer ID to retrieve all account users.

    • Is Enrolled in 2SV?(boolean): indicates if user enrolled in 2-step verification

    • Is Enforced in 2SV?(boolean): indicates if user is 2-step verification enforced

    • Is Mailbox Setup? (boolean): indicates if the user's Google mailbox is created

    • Custom Fields: all fields from a custom schema for a user

  • IMs

    • IM Network ID: user's IM accounts (user may have multiple IM accounts but only one primary)

    • Type: IM account type

      • home

      • work

      • custom

      • other

    • Custom Type: required, user defined value if IM type is custom

    • Protocol(option): IM network (custom network or standard network)

    • Custom Protocol: required, user defined value if the protocol is custom

    • Primary? (boolean): indicator if this is the user's primary IM

  • Emails

    • Email Address: email address of the user

    • Type (dropdown)

      • home

      • work

      • custom

      • other

    • Custom Type: required, user defined value if email address type selection is custom

    • Primary?(boolean): indicator if this is the user's primary email address

  • External IDs

    • Extenal ID: value of the ID

    • Type(option): type of external ID

      • account

      • custom

      • customer

      • login_ID

      • network

      • organization

    • Custom Type: required, user defined value if address type selection is custom

  • Relations

    • Relation Name: name of the person the user is related to

    • Type: type of relation

      • admin_assistant

      • assistant

      • brother

      • child

      • custom

      • domestic_partner

      • dotted_line_manager

      • exec_assistant

      • father

      • friend

      • manager

      • mother

      • parent

      • partner

      • referred_by

      • relative

      • sister

      • spouse

    • Custom Type: required, user defined value if type is custom

  • Addresses

    • Street: street portion of the user’s address

    • PO Box: user’s post office box

    • City: user’s city of residence

    • Region: user’s geographic region

    • Country: user’s country of residence

    • Country Code: telephone prefix for user’s country of residence (ISO 3166-1 standard)

    • Extended Address: extended fields for addresses that includes a sub-region

    • Formatted Address: formatted version of the address

    • Type (dropdown)

      • home

      • work

      • custom

      • other

    • Custom Type: required, user defined value if address type selection is custom

    • Primary? (boolean): indicator if this is the user's primary address

  • Organizations

    • Organization Name: name of the organization

    • Description: description of the organization

    • Department: department in the organization that the user is associated with (for example, sales or engineering)

    • Job Title: user's title in the organization (for example, member or engineer)

    • Location: physical location of the organization (this is not required to be an address)

    • Symbol: text string symbol of the organization (for example, Google's symbol is GOOG)

    • Cost Center: cost center of the user's organization

    • Domain: domain that the organization belongs to

    • Type: type of organization

    • Custom Type: required, user defined value if address type selection is custom

    • Primary? (boolean): indicator if this is the user's primary organization

  • Phones

    • Phone Number: human-readable phone number (any telephone number format)

    • Type: type of phone number

      • assistant

      • callback

      • car

      • company_main

      • custom

      • grand_central

      • home

      • home_fax

      • isdn

      • main

      • mobile

      • other

      • other_fax

      • pager

      • radio

      • telex

      • tty_ttd

      • work

      • work_fax

      • work_mobile

      • work_pager

    • Custom Type: required, user defined value if the type is custom

    • Primary?(boolean): indicator if this is the user's primary phone number

  • Websites

    • Website URL : URL of the website

    • Type: type or purpose of the website

      • app_install_page

      • blog

      • custom

      • ftp

      • home

      • home_page

      • other

      • profile

      • reservations

      • resume

      • work

    • Custom Type: required, user defined value if website type is custom

    • Primary? (boolean): indicator if this is the user's primary website

Related topics

G Suite Admin connector

About the elements of Okta Workflows

G Suite API documentation