Packages

final case class EndpointOidc(enabled: Option[Boolean] = None, optionsPassthrough: Boolean, cookiePrefix: String, inactivityTimeout: Long, maximumDuration: Duration, issuer: String, clientId: String, clientSecret: String, scopes: List[String]) extends Product with Serializable

A class encapsulating the EndpointOidc resource.

enabled

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

optionsPassthrough

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

cookiePrefix

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

inactivityTimeout

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.

maximumDuration

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

issuer

URL of the OIDC "OpenID provider". This is the base URL used for discovery.

clientId

The OIDC app's client ID and OIDC audience.

clientSecret

The OIDC app's client secret.

scopes

The set of scopes to request from the OIDC identity provider.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EndpointOidc
  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 EndpointOidc(enabled: Option[Boolean] = None, optionsPassthrough: Boolean, cookiePrefix: String, inactivityTimeout: Long, maximumDuration: Duration, issuer: String, clientId: String, clientSecret: String, scopes: List[String])

    create a new EndpointOidc.

    create a new EndpointOidc.

    enabled

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

    optionsPassthrough

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

    cookiePrefix

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

    inactivityTimeout

    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.

    maximumDuration

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

    issuer

    URL of the OIDC "OpenID provider". This is the base URL used for discovery.

    clientId

    The OIDC app's client ID and OIDC audience.

    clientSecret

    The OIDC app's client secret.

    scopes

    The set of scopes to request from the OIDC identity provider.

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 EndpointOidc toany2stringadd[EndpointOidc] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EndpointOidc, B)
    Implicit
    This member is added by an implicit conversion from EndpointOidc toArrowAssoc[EndpointOidc] 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: String
  8. val clientSecret: String
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. val cookiePrefix: String
  11. val enabled: Option[Boolean]
  12. def ensuring(cond: (EndpointOidc) => Boolean, msg: => Any): EndpointOidc
    Implicit
    This member is added by an implicit conversion from EndpointOidc toEnsuring[EndpointOidc] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (EndpointOidc) => Boolean): EndpointOidc
    Implicit
    This member is added by an implicit conversion from EndpointOidc toEnsuring[EndpointOidc] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): EndpointOidc
    Implicit
    This member is added by an implicit conversion from EndpointOidc toEnsuring[EndpointOidc] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): EndpointOidc
    Implicit
    This member is added by an implicit conversion from EndpointOidc toEnsuring[EndpointOidc] 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. val inactivityTimeout: Long
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val issuer: String
  22. val maximumDuration: Duration
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. val optionsPassthrough: Boolean
  27. def productElementNames: Iterator[String]
    Definition Classes
    Product
  28. val scopes: List[String]
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. 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 EndpointOidc toStringFormat[EndpointOidc] 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): (EndpointOidc, B)
    Implicit
    This member is added by an implicit conversion from EndpointOidc toArrowAssoc[EndpointOidc] 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 fromEndpointOidc to any2stringadd[EndpointOidc]

Inherited by implicit conversion StringFormat fromEndpointOidc to StringFormat[EndpointOidc]

Inherited by implicit conversion Ensuring fromEndpointOidc to Ensuring[EndpointOidc]

Inherited by implicit conversion ArrowAssoc fromEndpointOidc to ArrowAssoc[EndpointOidc]

Ungrouped