class Credentials extends AnyRef
Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
agent to connect the ngrok service as your account. They are installed with
the ngrok config add-authtoken command or by specifying it in the
ngrok.yml
configuration file with the authtoken property.
- Alphabetic
- By Inheritance
- Credentials
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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 Credentials toany2stringadd[Credentials] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (Credentials, B)
- Implicit
- This member is added by an implicit conversion from Credentials toArrowAssoc[Credentials] 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def create(description: Option[String] = None, metadata: Option[String] = None, acl: List[String] = List.empty): Future[Credential]
Create a new tunnel authtoken credential.
Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.
- description
human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
- metadata
arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
- acl
optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the
bindrule. Thebindrule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rulebind:example.ngrok.io. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule ofbind:*.example.comwhich will allowx.example.com,y.example.com,*.example.com, etc. A rule of'*'is equivalent to no acl at all and will explicitly permit all actions.- returns
a scala.concurrent.Future encapsulating the API call's result
- def delete(id: String): Future[Unit]
Delete a tunnel authtoken credential by ID
Delete a tunnel authtoken credential by ID
- id
a resource identifier
- returns
a scala.concurrent.Future encapsulating the API call's result
- def ensuring(cond: (Credentials) => Boolean, msg: => Any): Credentials
- Implicit
- This member is added by an implicit conversion from Credentials toEnsuring[Credentials] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (Credentials) => Boolean): Credentials
- Implicit
- This member is added by an implicit conversion from Credentials toEnsuring[Credentials] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): Credentials
- Implicit
- This member is added by an implicit conversion from Credentials toEnsuring[Credentials] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): Credentials
- Implicit
- This member is added by an implicit conversion from Credentials toEnsuring[Credentials] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def get(id: String): Future[Credential]
Get detailed information about a tunnel authtoken credential
Get detailed information about a tunnel authtoken credential
- id
a resource identifier
- returns
a scala.concurrent.Future encapsulating the API call's result
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def list(beforeId: Option[String] = None, limit: Option[String] = None): Future[Page[CredentialList]]
List all tunnel authtoken credentials on this account
List all tunnel authtoken credentials on this account
- beforeId
the value of the
before_idparameter as a scala.Predef.String- limit
the value of the
limitparameter as a scala.Predef.String- returns
a scala.concurrent.Future encapsulating the API call's result
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def update(id: String, description: Option[String] = None, metadata: Option[String] = None, acl: List[String] = List.empty): Future[Credential]
Update attributes of an tunnel authtoken credential by ID
Update attributes of an tunnel authtoken credential by ID
- id
the value of the
idparameter as a scala.Predef.String- description
human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
- metadata
arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
- acl
optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the
bindrule. Thebindrule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rulebind:example.ngrok.io. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule ofbind:*.example.comwhich will allowx.example.com,y.example.com,*.example.com, etc. A rule of'*'is equivalent to no acl at all and will explicitly permit all actions.- returns
a scala.concurrent.Future encapsulating the API call's result
- 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 Credentials toStringFormat[Credentials] 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): (Credentials, B)
- Implicit
- This member is added by an implicit conversion from Credentials toArrowAssoc[Credentials] 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.