Replace - ngrok documentation

Replace

curl --request PUT \
  --url https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '
{
  "edge_id": "<string>",
  "id": "<string>",
  "module": {
    "enabled": true,
    "provider": {
      "github": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ],
        "teams": [
          "<string>"
        ],
        "organizations": [
          "<string>"
        ]
      },
      "facebook": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      },
      "microsoft": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      },
      "google": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      },
      "linkedin": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      },
      "gitlab": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      },
      "twitch": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      },
      "amazon": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      }
    },
    "options_passthrough": true,
    "cookie_prefix": "<string>",
    "inactivity_timeout": 123,
    "maximum_duration": 123,
    "auth_check_interval": 123
  }
}
'

import requests

url = "https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth"

payload = {
    "edge_id": "<string>",
    "id": "<string>",
    "module": {
        "enabled": True,
        "provider": {
            "github": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"],
                "teams": ["<string>"],
                "organizations": ["<string>"]
            },
            "facebook": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            },
            "microsoft": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            },
            "google": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            },
            "linkedin": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            },
            "gitlab": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            },
            "twitch": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            },
            "amazon": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            }
        },
        "options_passthrough": True,
        "cookie_prefix": "<string>",
        "inactivity_timeout": 123,
        "maximum_duration": 123,
        "auth_check_interval": 123
    }
}
headers = {
    "ngrok-version": "<ngrok-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'ngrok-version': '<ngrok-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    edge_id: '<string>',
    id: '<string>',
    module: {
      enabled: true,
      provider: {
        github: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>'],
          teams: ['<string>'],
          organizations: ['<string>']
        },
        facebook: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        },
        microsoft: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        },
        google: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        },
        linkedin: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        },
        gitlab: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        },
        twitch: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        },
        amazon: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        }
      },
      options_passthrough: true,
      cookie_prefix: '<string>',
      inactivity_timeout: 123,
      maximum_duration: 123,
      auth_check_interval: 123
    }
  })
};

fetch('https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'edge_id' => '<string>',
    'id' => '<string>',
    'module' => [
        'enabled' => true,
        'provider' => [
                'github' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ],
                                'teams' => [
                                                                '<string>'
                                ],
                                'organizations' => [
                                                                '<string>'
                                ]
                ],
                'facebook' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ],
                'microsoft' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ],
                'google' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ],
                'linkedin' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ],
                'gitlab' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ],
                'twitch' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ],
                'amazon' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ]
        ],
        'options_passthrough' => true,
        'cookie_prefix' => '<string>',
        'inactivity_timeout' => 123,
        'maximum_duration' => 123,
        'auth_check_interval' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "ngrok-version: <ngrok-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth"

	payload := strings.NewReader("{\n  \"edge_id\": \"<string>\",\n  \"id\": \"<string>\",\n  \"module\": {\n    \"enabled\": true,\n    \"provider\": {\n      \"github\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ],\n        \"teams\": [\n          \"<string>\"\n        ],\n        \"organizations\": [\n          \"<string>\"\n        ]\n      },\n      \"facebook\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"microsoft\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"google\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"linkedin\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"gitlab\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"twitch\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"amazon\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"options_passthrough\": true,\n    \"cookie_prefix\": \"<string>\",\n    \"inactivity_timeout\": 123,\n    \"maximum_duration\": 123,\n    \"auth_check_interval\": 123\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("ngrok-version", "<ngrok-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth")
  .header("ngrok-version", "<ngrok-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"edge_id\": \"<string>\",\n  \"id\": \"<string>\",\n  \"module\": {\n    \"enabled\": true,\n    \"provider\": {\n      \"github\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ],\n        \"teams\": [\n          \"<string>\"\n        ],\n        \"organizations\": [\n          \"<string>\"\n        ]\n      },\n      \"facebook\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"microsoft\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"google\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"linkedin\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"gitlab\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"twitch\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"amazon\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"options_passthrough\": true,\n    \"cookie_prefix\": \"<string>\",\n    \"inactivity_timeout\": 123,\n    \"maximum_duration\": 123,\n    \"auth_check_interval\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["ngrok-version"] = '<ngrok-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"edge_id\": \"<string>\",\n  \"id\": \"<string>\",\n  \"module\": {\n    \"enabled\": true,\n    \"provider\": {\n      \"github\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ],\n        \"teams\": [\n          \"<string>\"\n        ],\n        \"organizations\": [\n          \"<string>\"\n        ]\n      },\n      \"facebook\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"microsoft\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"google\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"linkedin\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"gitlab\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"twitch\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"amazon\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"options_passthrough\": true,\n    \"cookie_prefix\": \"<string>\",\n    \"inactivity_timeout\": 123,\n    \"maximum_duration\": 123,\n    \"auth_check_interval\": 123\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "enabled": true,
  "provider": {
    "github": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ],
      "teams": [
        "<string>"
      ],
      "organizations": [
        "<string>"
      ]
    },
    "facebook": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    },
    "microsoft": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    },
    "google": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    },
    "linkedin": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    },
    "gitlab": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    },
    "twitch": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    },
    "amazon": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    }
  },
  "options_passthrough": true,
  "cookie_prefix": "<string>",
  "inactivity_timeout": 123,
  "maximum_duration": 123,
  "auth_check_interval": 123
}

PUT

edges

https

{edge_id}

routes

{id}

oauth

Replace

curl --request PUT \
  --url https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '
{
  "edge_id": "<string>",
  "id": "<string>",
  "module": {
    "enabled": true,
    "provider": {
      "github": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ],
        "teams": [
          "<string>"
        ],
        "organizations": [
          "<string>"
        ]
      },
      "facebook": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      },
      "microsoft": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      },
      "google": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      },
      "linkedin": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      },
      "gitlab": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      },
      "twitch": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      },
      "amazon": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": [
          "<string>"
        ],
        "email_addresses": [
          "<string>"
        ],
        "email_domains": [
          "<string>"
        ]
      }
    },
    "options_passthrough": true,
    "cookie_prefix": "<string>",
    "inactivity_timeout": 123,
    "maximum_duration": 123,
    "auth_check_interval": 123
  }
}
'

import requests

url = "https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth"

payload = {
    "edge_id": "<string>",
    "id": "<string>",
    "module": {
        "enabled": True,
        "provider": {
            "github": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"],
                "teams": ["<string>"],
                "organizations": ["<string>"]
            },
            "facebook": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            },
            "microsoft": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            },
            "google": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            },
            "linkedin": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            },
            "gitlab": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            },
            "twitch": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            },
            "amazon": {
                "client_id": "<string>",
                "client_secret": "<string>",
                "scopes": ["<string>"],
                "email_addresses": ["<string>"],
                "email_domains": ["<string>"]
            }
        },
        "options_passthrough": True,
        "cookie_prefix": "<string>",
        "inactivity_timeout": 123,
        "maximum_duration": 123,
        "auth_check_interval": 123
    }
}
headers = {
    "ngrok-version": "<ngrok-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'ngrok-version': '<ngrok-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    edge_id: '<string>',
    id: '<string>',
    module: {
      enabled: true,
      provider: {
        github: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>'],
          teams: ['<string>'],
          organizations: ['<string>']
        },
        facebook: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        },
        microsoft: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        },
        google: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        },
        linkedin: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        },
        gitlab: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        },
        twitch: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        },
        amazon: {
          client_id: '<string>',
          client_secret: '<string>',
          scopes: ['<string>'],
          email_addresses: ['<string>'],
          email_domains: ['<string>']
        }
      },
      options_passthrough: true,
      cookie_prefix: '<string>',
      inactivity_timeout: 123,
      maximum_duration: 123,
      auth_check_interval: 123
    }
  })
};

fetch('https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'edge_id' => '<string>',
    'id' => '<string>',
    'module' => [
        'enabled' => true,
        'provider' => [
                'github' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ],
                                'teams' => [
                                                                '<string>'
                                ],
                                'organizations' => [
                                                                '<string>'
                                ]
                ],
                'facebook' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ],
                'microsoft' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ],
                'google' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ],
                'linkedin' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ],
                'gitlab' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ],
                'twitch' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ],
                'amazon' => [
                                'client_id' => '<string>',
                                'client_secret' => '<string>',
                                'scopes' => [
                                                                '<string>'
                                ],
                                'email_addresses' => [
                                                                '<string>'
                                ],
                                'email_domains' => [
                                                                '<string>'
                                ]
                ]
        ],
        'options_passthrough' => true,
        'cookie_prefix' => '<string>',
        'inactivity_timeout' => 123,
        'maximum_duration' => 123,
        'auth_check_interval' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "ngrok-version: <ngrok-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth"

	payload := strings.NewReader("{\n  \"edge_id\": \"<string>\",\n  \"id\": \"<string>\",\n  \"module\": {\n    \"enabled\": true,\n    \"provider\": {\n      \"github\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ],\n        \"teams\": [\n          \"<string>\"\n        ],\n        \"organizations\": [\n          \"<string>\"\n        ]\n      },\n      \"facebook\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"microsoft\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"google\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"linkedin\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"gitlab\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"twitch\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"amazon\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"options_passthrough\": true,\n    \"cookie_prefix\": \"<string>\",\n    \"inactivity_timeout\": 123,\n    \"maximum_duration\": 123,\n    \"auth_check_interval\": 123\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("ngrok-version", "<ngrok-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth")
  .header("ngrok-version", "<ngrok-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"edge_id\": \"<string>\",\n  \"id\": \"<string>\",\n  \"module\": {\n    \"enabled\": true,\n    \"provider\": {\n      \"github\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ],\n        \"teams\": [\n          \"<string>\"\n        ],\n        \"organizations\": [\n          \"<string>\"\n        ]\n      },\n      \"facebook\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"microsoft\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"google\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"linkedin\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"gitlab\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"twitch\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"amazon\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"options_passthrough\": true,\n    \"cookie_prefix\": \"<string>\",\n    \"inactivity_timeout\": 123,\n    \"maximum_duration\": 123,\n    \"auth_check_interval\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oauth")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["ngrok-version"] = '<ngrok-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"edge_id\": \"<string>\",\n  \"id\": \"<string>\",\n  \"module\": {\n    \"enabled\": true,\n    \"provider\": {\n      \"github\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ],\n        \"teams\": [\n          \"<string>\"\n        ],\n        \"organizations\": [\n          \"<string>\"\n        ]\n      },\n      \"facebook\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"microsoft\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"google\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"linkedin\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"gitlab\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"twitch\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      },\n      \"amazon\": {\n        \"client_id\": \"<string>\",\n        \"client_secret\": \"<string>\",\n        \"scopes\": [\n          \"<string>\"\n        ],\n        \"email_addresses\": [\n          \"<string>\"\n        ],\n        \"email_domains\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"options_passthrough\": true,\n    \"cookie_prefix\": \"<string>\",\n    \"inactivity_timeout\": 123,\n    \"maximum_duration\": 123,\n    \"auth_check_interval\": 123\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "enabled": true,
  "provider": {
    "github": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ],
      "teams": [
        "<string>"
      ],
      "organizations": [
        "<string>"
      ]
    },
    "facebook": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    },
    "microsoft": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    },
    "google": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    },
    "linkedin": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    },
    "gitlab": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    },
    "twitch": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    },
    "amazon": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "scopes": [
        "<string>"
      ],
      "email_addresses": [
        "<string>"
      ],
      "email_domains": [
        "<string>"
      ]
    }
  },
  "options_passthrough": true,
  "cookie_prefix": "<string>",
  "inactivity_timeout": 123,
  "maximum_duration": 123,
  "auth_check_interval": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ngrok-version

integer

default:2

required

Path Parameters

edge_id

string

required

string

required

Body

application/json

edge_id

string

n/a

string

n/a

module

object

n/a

Show child attributes

Response

200 - application/json

n/a

enabled

boolean

true if the module will be applied to traffic, false to disable. default true if unspecified

provider

object

an object which defines the identity provider to use for authentication and configuration for who may access the endpoint

Show child attributes

options_passthrough

boolean

Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.

the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'

inactivity_timeout

integer

Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.

maximum_duration

integer

Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.

auth_check_interval

integer

Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.

Get Delete