Prerequisites
- Your admin must install and configure the GitHub connector, add the GitHub actions pack under Admin > Actions, and enable this action.
- A GitHub app must be installed on the relevant organization(s) and linked to the correct GitHub datasource in the Glean admin console.
Supported parameters
This action does not accept any input parameters. It automatically retrieves profile information for the currently authenticated GitHub user.Usage examples
- “Show me my GitHub profile information.”
- “What is my GitHub username and email address?”
- “How many public repositories do I have on GitHub?”
Troubleshooting
Authentication or authorization failure
Authentication or authorization failure
Incomplete profile information returned
Incomplete profile information returned
- Possible cause: The user has set certain profile fields to private or has not filled them out in their GitHub account.
- Fix: This is expected behavior. The action can only return information that is available in the GitHub profile of the user. Users can update their profile visibility settings directly in GitHub if they want to share more information.
Action fails with 403 forbidden error
Action fails with 403 forbidden error
- Possible cause: The GitHub app does not have permission to read user profile data, or the OAuth scopes are insufficient.
- Fix: Verify that the GitHub app has the correct OAuth scopes enabled. The app needs user profile read permissions. Contact your admin to review the GitHub app configuration.
FAQs
Can this action retrieve profile information for other users?
Can this action retrieve profile information for other users?
No. This action only retrieves profile information for the currently authenticated user. To get information about other GitHub users, you would need to use a different action that accepts a username parameter.
Does this action work with GitHub Enterprise?
Does this action work with GitHub Enterprise?
This action is designed for GitHub.com and GitHub Enterprise Cloud. Support for GitHub Enterprise Server depends on your GitHub connector configuration. Confirm with your admin if you are using GitHub Enterprise Server.
Will this action expose private email addresses?
Will this action expose private email addresses?
The action may return private email addresses if the authenticated user has made them available through their GitHub account settings. The action respects GitHub’s privacy settings and only returns information that the user has permission to access about their own account.