Read User

Read a user's GitHub profile.

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 the public information for a user.

Options

Field Definition Type Required

Organization

Organizations in GitHub.

Dropdown

FALSE

Input

Field Definition Type Required

Username

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

Text

TRUE

Output

Field Definition Type

Username

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

Text

User ID

Unique identifier 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

Type

Type of data returned.

Text

Is Site Admin?

Indicates whether the user is a site admin (True) or not (False).

Text

Public Name

Publicly displayed name of the user.

Text

Blog URL

URL of the user's blog.

Text

Company

Company where the user is employed.

Text

Location

City of residence of the user.

Text

Email

Email address of the user.

Text

Is Hireable?

Indicates whether the user can be hired (True) or not (False).

Text

Biography

A brief description of the user.

Text

Twitter Username

Twitter handle of the user.

Text

Public Repositories

Number of public repositories to which the user has access.

Text

Public Gists

Number of public gists to which the user has access.

Text

Followers

Number of followers of the user.

Text

Following

Number of people whom the user follows.

Text

Created At

Date and time when the object was created.

Text

Updated At

Date and time when the user profile was last updated.

Text

SCIM User ID

A unique identifier generated by the GitHub SCIM endpoint.

Text

SCIM Username

Username for the user generated by the GitHub SCIM endpoint.

Text

External ID

A unique identifier generated by the SAML provider and matched against a GitHub user.

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

Is Active?

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

Text

Resource Type

Resource type for the user.

Text

Related topics

GitHub connector

Workflow elements

GitHub API documentation