final case class SshCredential(id: String, uri: URI, createdAt: OffsetDateTime, description: String, metadata: String, publicKey: String, acl: List[String]) extends Product with Serializable
A class encapsulating the SshCredential resource.
- id
unique ssh credential resource identifier
- uri
URI of the ssh credential API resource
- createdAt
timestamp when the ssh credential was created, RFC 3339 format
- description
human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
- metadata
arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
- publicKey
the PEM-encoded public key of the SSH keypair that will be used to authenticate
- 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.
- Alphabetic
- By Inheritance
- SshCredential
- Serializable
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SshCredential(id: String, uri: URI, createdAt: OffsetDateTime, description: String, metadata: String, publicKey: String, acl: List[String])
create a new SshCredential.
create a new SshCredential.
- id
unique ssh credential resource identifier
- uri
URI of the ssh credential API resource
- createdAt
timestamp when the ssh credential was created, RFC 3339 format
- description
human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
- metadata
arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
- publicKey
the PEM-encoded public key of the SSH keypair that will be used to authenticate
- 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.
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 SshCredential toany2stringadd[SshCredential] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (SshCredential, B)
- Implicit
- This member is added by an implicit conversion from SshCredential toArrowAssoc[SshCredential] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val acl: List[String]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val createdAt: OffsetDateTime
- val description: String
- def ensuring(cond: (SshCredential) => Boolean, msg: => Any): SshCredential
- Implicit
- This member is added by an implicit conversion from SshCredential toEnsuring[SshCredential] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (SshCredential) => Boolean): SshCredential
- Implicit
- This member is added by an implicit conversion from SshCredential toEnsuring[SshCredential] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): SshCredential
- Implicit
- This member is added by an implicit conversion from SshCredential toEnsuring[SshCredential] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): SshCredential
- Implicit
- This member is added by an implicit conversion from SshCredential toEnsuring[SshCredential] 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()
- val id: String
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val metadata: String
- 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 publicKey: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val uri: URI
- 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 SshCredential toStringFormat[SshCredential] 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): (SshCredential, B)
- Implicit
- This member is added by an implicit conversion from SshCredential toArrowAssoc[SshCredential] 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.