Search Users

Search for users in GitHub.

To use this action card in a flow, you must set up SAML support for your app in your GitHub instance. If SAML support isn't set up properly, search results only show public information for a user. You must also be the owner of the organization.

Options

Field Definition Type Required

Organization

Organizations in GitHub.

Dropdown

FALSE

Result Set

Choose a method to filter search results:

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

  • All Matching Records: Returns all matching records as a list.

Dropdown

FALSE

For more accurate results, avoid using partial strings in your input query.

Due to GitHub limitations, this action card returns a maximum of 1,000 records.

Input

Field Definition Type Required

Username

Username for the user. This can be a sign-in account or a username.

Text

FALSE

Public Full Name

Public full name of the user.

Text

FALSE

Public Email

Public email address of the user.

Text

FALSE

Output

Field Definition Type

ID

Unique identifier of the user.

Number

Username

Username for the user. This can be a sign-in account or a username.

Text

Public Name

Publicly displayed name of the user.

Text

Global Node ID

The node_id value of the user in the GitHub API.

Text

Avatar URL

URL of the user's avatar.

Text

HTML URL

URL of the user, for example, https://github.com/octocat.

Text

SCIM ID

Unique identifier generated by the GitHub SCIM endpoint.

Text

SCIM Username

Username for the user generated by the GitHub SCIM endpoint.

Text

Given Name

First name of the user.

Text

Family Name

Family name of the user.

Text

Emails

Email addresses associated with the user.

List of Text

Active

This indicates whether the identity is active (True) or should be deprovisioned (False).

True/False

Related topics

GitHub connector

Workflow elements

GitHub API documentation