Packages

final case class EndpointOAuthMicrosoft(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 EndpointOAuthMicrosoft 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_id and client_secret to 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

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EndpointOAuthMicrosoft
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new EndpointOAuthMicrosoft(clientId: Option[String] = None, clientSecret: Option[String] = None, scopes: List[String], emailAddresses: List[String], emailDomains: List[String])

    create a new EndpointOAuthMicrosoft.

    create a new EndpointOAuthMicrosoft.

    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_id and client_secret to 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from EndpointOAuthMicrosoft toany2stringadd[EndpointOAuthMicrosoft] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EndpointOAuthMicrosoft, B)
    Implicit
    This member is added by an implicit conversion from EndpointOAuthMicrosoft toArrowAssoc[EndpointOAuthMicrosoft] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val clientId: Option[String]
  8. val clientSecret: Option[String]
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. val emailAddresses: List[String]
  11. val emailDomains: List[String]
  12. def ensuring(cond: (EndpointOAuthMicrosoft) => Boolean, msg: => Any): EndpointOAuthMicrosoft
    Implicit
    This member is added by an implicit conversion from EndpointOAuthMicrosoft toEnsuring[EndpointOAuthMicrosoft] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (EndpointOAuthMicrosoft) => Boolean): EndpointOAuthMicrosoft
    Implicit
    This member is added by an implicit conversion from EndpointOAuthMicrosoft toEnsuring[EndpointOAuthMicrosoft] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): EndpointOAuthMicrosoft
    Implicit
    This member is added by an implicit conversion from EndpointOAuthMicrosoft toEnsuring[EndpointOAuthMicrosoft] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): EndpointOAuthMicrosoft
    Implicit
    This member is added by an implicit conversion from EndpointOAuthMicrosoft toEnsuring[EndpointOAuthMicrosoft] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val scopes: List[String]
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EndpointOAuthMicrosoft toStringFormat[EndpointOAuthMicrosoft] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def [B](y: B): (EndpointOAuthMicrosoft, B)
    Implicit
    This member is added by an implicit conversion from EndpointOAuthMicrosoft toArrowAssoc[EndpointOAuthMicrosoft] 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.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromEndpointOAuthMicrosoft to any2stringadd[EndpointOAuthMicrosoft]

Inherited by implicit conversion StringFormat fromEndpointOAuthMicrosoft to StringFormat[EndpointOAuthMicrosoft]

Inherited by implicit conversion Ensuring fromEndpointOAuthMicrosoft to Ensuring[EndpointOAuthMicrosoft]

Inherited by implicit conversion ArrowAssoc fromEndpointOAuthMicrosoft to ArrowAssoc[EndpointOAuthMicrosoft]

Ungrouped