Package com.ngrok.definitions

Class EndpointOAuthGitHub

java.lang.Object
com.ngrok.definitions.EndpointOAuthGitHub
public class EndpointOAuthGitHub extends Object
A class encapsulating the EndpointOAuthGitHub resource.

  • Method Details

    • newBuilder

      public static EndpointOAuthGitHub.Builder newBuilder()
      Creates a new builder for the EndpointOAuthGitHub type.
      Returns:
      a new EndpointOAuthGitHub.Builder

    • getClientId

      public Optional<String> getClientId()
      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.
      Returns:
      the value of the property as a String wrapped in an Optional

    • getClientSecret

      public Optional<String> getClientSecret()
      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.
      Returns:
      the value of the property as a String wrapped in an Optional

    • getScopes

      public List<String> getScopes()
      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)
      Returns:
      the value of the property as a List of String

    • getEmailAddresses

      public List<String> getEmailAddresses()
      a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
      Returns:
      the value of the property as a List of String

    • getEmailDomains

      public List<String> getEmailDomains()
      a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
      Returns:
      the value of the property as a List of String

    • getTeams

      public List<String> getTeams()
      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
      Returns:
      the value of the property as a List of String

    • getOrganizations

      public List<String> getOrganizations()
      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'
      Returns:
      the value of the property as a List of String

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object