class SshHostCertificates extends AnyRef
SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.
See also https://ngrok.com/docs/api#api-ssh-host-certificates.
- Alphabetic
- By Inheritance
- SshHostCertificates
- 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 SshHostCertificates toany2stringadd[SshHostCertificates] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (SshHostCertificates, B)
- Implicit
- This member is added by an implicit conversion from SshHostCertificates toArrowAssoc[SshHostCertificates] 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(sshCertificateAuthorityId: String, publicKey: String, principals: List[String] = List.empty, validAfter: Option[OffsetDateTime] = None, validUntil: Option[OffsetDateTime] = None, description: Option[String] = None, metadata: Option[String] = None): Future[SshHostCertificate]
Create a new SSH Host Certificate
Create a new SSH Host Certificate
See also https://ngrok.com/docs/api#api-ssh-host-certificates-create.
- sshCertificateAuthorityId
the ssh certificate authority that is used to sign this ssh host certificate
- publicKey
a public key in OpenSSH Authorized Keys format that this certificate signs
- principals
the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.
- validAfter
The time when the host certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.
- validUntil
The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of one year in the future will be used. The OpenSSH certificates RFC calls this
valid_before.- description
human-readable description of this SSH Host Certificate. optional, max 255 bytes.
- metadata
arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
- returns
a scala.concurrent.Future encapsulating the API call's result
- def delete(id: String): Future[Unit]
Delete an SSH Host Certificate
Delete an SSH Host Certificate
See also https://ngrok.com/docs/api#api-ssh-host-certificates-delete.
- id
a resource identifier
- returns
a scala.concurrent.Future encapsulating the API call's result
- def ensuring(cond: (SshHostCertificates) => Boolean, msg: => Any): SshHostCertificates
- Implicit
- This member is added by an implicit conversion from SshHostCertificates toEnsuring[SshHostCertificates] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (SshHostCertificates) => Boolean): SshHostCertificates
- Implicit
- This member is added by an implicit conversion from SshHostCertificates toEnsuring[SshHostCertificates] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): SshHostCertificates
- Implicit
- This member is added by an implicit conversion from SshHostCertificates toEnsuring[SshHostCertificates] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): SshHostCertificates
- Implicit
- This member is added by an implicit conversion from SshHostCertificates toEnsuring[SshHostCertificates] 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[SshHostCertificate]
Get detailed information about an SSH Host Certficate
Get detailed information about an SSH Host Certficate
See also https://ngrok.com/docs/api#api-ssh-host-certificates-get.
- 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[SshHostCertificateList]]
List all SSH Host Certificates issued on this account
List all SSH Host Certificates issued on this account
See also https://ngrok.com/docs/api#api-ssh-host-certificates-list.
- 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): Future[SshHostCertificate]
Update an SSH Host Certificate
Update an SSH Host Certificate
See also https://ngrok.com/docs/api#api-ssh-host-certificates-update.
- id
the value of the
idparameter as a scala.Predef.String- description
human-readable description of this SSH Host Certificate. optional, max 255 bytes.
- metadata
arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
- 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 SshHostCertificates toStringFormat[SshHostCertificates] 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): (SshHostCertificates, B)
- Implicit
- This member is added by an implicit conversion from SshHostCertificates toArrowAssoc[SshHostCertificates] 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.