Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EndpointOAuthGitHub

Hierarchy

  • EndpointOAuthGitHub

Index

Properties

Optional clientId

clientId: string

the OAuth app client ID. retrieve it from the identity provider's dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well.

Optional clientSecret

clientSecret: string

the OAuth app client secret. retrieve if from the identity provider's dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for client_id.

emailAddresses

emailAddresses: string[]

a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint

emailDomains

emailDomains: string[]

a list of email domains of users authenticated by identity provider who are allowed access to the endpoint

organizations

organizations: string[]

a list of github org identifiers. users who are members of any of the listed organizations will be allowed access. identifiers should be the organization's 'slug'

scopes

scopes: string[]

a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)

teams

teams: string[]

a list of github teams identifiers. users will be allowed access to the endpoint if they are a member of any of these teams. identifiers should be in the 'slug' format qualified with the org name, e.g. org-name/team-name

Generated using TypeDoc