Amazon OAuth

This guide walks you through configuring ngrok to use Amazon OAuth (Login with Amazon) for user authentication. The steps below follow Amazon’s Register for Login with Amazon documentation for websites.

What you’ll need

Your Amazon Developer account (sign up if you don’t have one).
Your ngrok authtoken and an endpoint with the OAuth action in its Traffic Policy.

Create a security profile for ngrok

Follow Amazon’s documentation for registering with Login with Amazon to create a security profile in the Login with Amazon portal, then set the following in the profile’s web settings:

Allowed Return URLs: add https://idp.ngrok.com/oauth2/callback.

Note the security profile’s Client ID and Client Secret for use in your Traffic Policy below.

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: amazon
          client_id: '{your app''s oauth client id}'
          client_secret: '{your app''s oauth client secret}'
          scopes:
            - profile

{
  "on_http_request": [
    {
      "actions": [
        {
          "type": "oauth",
          "config": {
            "provider": "amazon",
            "client_id": "{your app's oauth client id}",
            "client_secret": "{your app's oauth client secret}",
            "scopes": [
              "profile"
            ]
          }
        }
      ]
    }
  ]
}

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 security profile for ngrok

Update your ngrok endpoint Traffic Policy

Configure access control

Further resources

​What you’ll need

​Create a security profile for ngrok

​Update your ngrok endpoint Traffic Policy

​Configure access control

​Further resources

What you’ll need

Create a security profile for ngrok

Update your ngrok endpoint Traffic Policy

Configure access control

Further resources