final case class EndpointOAuthGoogle(clientId: Option[String] = None, clientSecret: Option[String] = None, scopes: List[String], emailAddresses: List[String], emailDomains: List[String]) extends Product with Serializable
A class encapsulating the EndpointOAuthGoogle resource.
- clientId
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.
- clientSecret
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.- scopes
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_idandclient_secretto set scopes)- emailAddresses
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- emailDomains
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- Alphabetic
- By Inheritance
- EndpointOAuthGoogle
- Serializable
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new EndpointOAuthGoogle(clientId: Option[String] = None, clientSecret: Option[String] = None, scopes: List[String], emailAddresses: List[String], emailDomains: List[String])
create a new EndpointOAuthGoogle.
create a new EndpointOAuthGoogle.
- clientId
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.
- clientSecret
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.- scopes
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_idandclient_secretto set scopes)- emailAddresses
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- emailDomains
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from EndpointOAuthGoogle toany2stringadd[EndpointOAuthGoogle] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (EndpointOAuthGoogle, B)
- Implicit
- This member is added by an implicit conversion from EndpointOAuthGoogle toArrowAssoc[EndpointOAuthGoogle] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val clientId: Option[String]
- val clientSecret: Option[String]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val emailAddresses: List[String]
- val emailDomains: List[String]
- def ensuring(cond: (EndpointOAuthGoogle) => Boolean, msg: => Any): EndpointOAuthGoogle
- Implicit
- This member is added by an implicit conversion from EndpointOAuthGoogle toEnsuring[EndpointOAuthGoogle] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (EndpointOAuthGoogle) => Boolean): EndpointOAuthGoogle
- Implicit
- This member is added by an implicit conversion from EndpointOAuthGoogle toEnsuring[EndpointOAuthGoogle] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): EndpointOAuthGoogle
- Implicit
- This member is added by an implicit conversion from EndpointOAuthGoogle toEnsuring[EndpointOAuthGoogle] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): EndpointOAuthGoogle
- Implicit
- This member is added by an implicit conversion from EndpointOAuthGoogle toEnsuring[EndpointOAuthGoogle] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val scopes: List[String]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from EndpointOAuthGoogle toStringFormat[EndpointOAuthGoogle] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (EndpointOAuthGoogle, B)
- Implicit
- This member is added by an implicit conversion from EndpointOAuthGoogle toArrowAssoc[EndpointOAuthGoogle] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.