GitHub OAuth

Create a GitHub OAuth application

Follow GitHub’s documentation for creating an OAuth app until the final step of submitting the registration form.

Set the Authorization callback URL to https://idp.ngrok.com/oauth2/callback.

Submit the form.

From the application overview, copy your Client ID. Under Client secrets, select Generate a new client secret, then copy the secret immediately, since GitHub displays its full value only once. Save both for use in ngrok.

Update your ngrok endpoint Traffic Policy

Access the ngrok Dashboard Endpoints page and locate an existing endpoint you’d like to add this to or create a new one.

In your traffic policy, add the following configuration:

You may add any scopes that are required by your application with the following caveats.

Scopes which require a Facebook app review are unsupported.
ngrok will enforce that users accept all permissions before completing authorization.

on_http_request:
  - actions:
      - type: oauth
        config:
          provider: github
          client_id: '{your app''s oauth client id}'
          client_secret: '{your app''s oauth client secret}'
          scopes:
            - read:user
            - read:org

{
  "on_http_request": [
    {
      "actions": [
        {
          "type": "oauth",
          "config": {
            "provider": "github",
            "client_id": "{your app's oauth client id}",
            "client_secret": "{your app's oauth client secret}",
            "scopes": [
              "read:user",
              "read:org"
            ]
          }
        }
      ]
    }
  ]
}

Click Save to validate and update your traffic policy.

Configure access control

Optionally, configure access control to your service by only allowing specific users or domains.

on_http_request:
  - expressions:
      - '!(actions.ngrok.oauth.identity.email in [''me@example.com''])'
    actions:
      - type: deny

{
  "on_http_request": [
    {
      "expressions": [
        "!(actions.ngrok.oauth.identity.email in ['me@example.com'])"
      ],
      "actions": [
        {
          "type": "deny"
        }
      ]
    }
  ]
}

General Guides

CLI Credentials

Dashboard SSO

Databases

Endpoints SSO

Event Destinations

Frameworks

JWT Validation

Kubernetes Ingress

OAuth

Protocols

Webhooks

Web Servers

What you’ll need

Create a GitHub OAuth application

Update your ngrok endpoint Traffic Policy

Configure access control

Known limitations

​What you’ll need

​Create a GitHub OAuth application

​Update your ngrok endpoint Traffic Policy

​Configure access control

​Known limitations

What you’ll need

Create a GitHub OAuth application

Update your ngrok endpoint Traffic Policy

Configure access control

Known limitations