Skip to main content
Version: 26.1

GitHub

Our open source test reporting tool allows logging in via GitHub OAuth Web Application Flow.

Presequences​

To enable this feature you need to register new application in Github

Fill the following fields:

NameValueDescription
Application nameReport PortalJust something which allow you recognize what's this.
Homepage URLhttps://{HOST}:{PORT}/api/sso/userReplace with {HOST} and {PORT} with appropriate values of your instance. Naturally you can omit :{PORT} if it's default port for HTTPS protocol.
Authorization callback URLhttps://{HOST}:{PORT}/api/sso/login/githubAs in the previous field replace with {HOST} and {PORT} with your appropriate values.

Once new application is created, you will have Client ID. Click on "Generate a new client secret" to get Client Secret, but do not close the window until you configure the Authorization on RP, since it will never show you the Secret again.

ReportPortal configuration​

To configure GitHub authentication in ReportPortal:

  1. Log in to ReportPortal as Admin.
  2. Navigate to Instance plugins -> Authorization tab.
  3. Click on "GitHub Auth" panel.
  4. Click "Add integration" button.
  5. Fill in the necessary fields:
'Client ID': <value_of_clientId>
'Client Secret': <value_of_clientSecret>
'Add GitHub Organization' button-link: (optional)
note

In case the 'Organization Name' is not added, all GitHub users will have access to the ReportPortal instance.
If the 'Organization Name' is specified, only users of this organization will have an access to ReportPortal instance.
If the Name of GitHub organization is not validated, verify that the name is correct.

Example of GitHub auth configuration: Fill in the form:

'Client Id': 8767988c424a0e7a2640
'Client Secret': ef22c9f804257afaf399a2dada7c8f22dee5fd1b
'Organization Name': reportportal

Click on 'Submit' button. A confirmation message in status bar should be shown. A 'Login with GitHub' button will appear on login form.

Resolving organization restrictions for OAuth Apps​

If you’ve specified an Organization Name in your configuration, ensure the organization allows access to your OAuth app.

To do this:

  1. Navigate to your organization’s Settings → Third-party access → OAuth app policy.
  2. Choose one of the following actions:
    • Remove restrictions to allow all verified OAuth apps, OR
    • Transfer ownership of your OAuth app to the organization, or create a new OAuth app directly under the organization via Developer Settings.