Packages

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 bind rule. The bind rule 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 rule bind: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 of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SshCredential
  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 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 bind rule. The bind rule 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 rule bind: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 of bind:*.example.com which will allow x.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

  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 SshCredential toany2stringadd[SshCredential] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. 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()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val acl: List[String]
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. val createdAt: OffsetDateTime
  10. val description: String
  11. 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
  12. 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
  13. 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
  14. 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
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. val id: String
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val metadata: String
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. val publicKey: String
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. val uri: URI
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. 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 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 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): (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.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromSshCredential to any2stringadd[SshCredential]

Inherited by implicit conversion StringFormat fromSshCredential to StringFormat[SshCredential]

Inherited by implicit conversion Ensuring fromSshCredential to Ensuring[SshCredential]

Inherited by implicit conversion ArrowAssoc fromSshCredential to ArrowAssoc[SshCredential]

Ungrouped