class SshUserCertificates extends AnyRef

SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.

See also https://ngrok.com/docs/api#api-ssh-user-certificates.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SshUserCertificates
  2. AnyRef
  3. 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

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 SshUserCertificates toany2stringadd[SshUserCertificates] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SshUserCertificates, B)
    Implicit
    This member is added by an implicit conversion from SshUserCertificates toArrowAssoc[SshUserCertificates] 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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def create(sshCertificateAuthorityId: String, publicKey: String, principals: List[String] = List.empty, criticalOptions: Map[String, String] = Map.empty, extensions: Map[String, String] = Map.empty, validAfter: Option[OffsetDateTime] = None, validUntil: Option[OffsetDateTime] = None, description: Option[String] = None, metadata: Option[String] = None): Future[SshUserCertificate]

    Create a new SSH User Certificate

    Create a new SSH User Certificate

    See also https://ngrok.com/docs/api#api-ssh-user-certificates-create.

    sshCertificateAuthorityId

    the ssh certificate authority that is used to sign this ssh user certificate

    publicKey

    a public key in OpenSSH Authorized Keys format that this certificate signs

    principals

    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.

    criticalOptions

    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.

    extensions

    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.

    validAfter

    The time when the user 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 24 hours will be used. The OpenSSH certificates RFC calls this valid_before.

    description

    human-readable description of this SSH User Certificate. optional, max 255 bytes.

    metadata

    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.

    returns

    a scala.concurrent.Future encapsulating the API call's result

  9. def delete(id: String): Future[Unit]

    Delete an SSH User Certificate

    Delete an SSH User Certificate

    See also https://ngrok.com/docs/api#api-ssh-user-certificates-delete.

    id

    a resource identifier

    returns

    a scala.concurrent.Future encapsulating the API call's result

  10. def ensuring(cond: (SshUserCertificates) => Boolean, msg: => Any): SshUserCertificates
    Implicit
    This member is added by an implicit conversion from SshUserCertificates toEnsuring[SshUserCertificates] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (SshUserCertificates) => Boolean): SshUserCertificates
    Implicit
    This member is added by an implicit conversion from SshUserCertificates toEnsuring[SshUserCertificates] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): SshUserCertificates
    Implicit
    This member is added by an implicit conversion from SshUserCertificates toEnsuring[SshUserCertificates] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): SshUserCertificates
    Implicit
    This member is added by an implicit conversion from SshUserCertificates toEnsuring[SshUserCertificates] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. def get(id: String): Future[SshUserCertificate]

    Get detailed information about an SSH User Certficate

    Get detailed information about an SSH User Certficate

    See also https://ngrok.com/docs/api#api-ssh-user-certificates-get.

    id

    a resource identifier

    returns

    a scala.concurrent.Future encapsulating the API call's result

  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def list(beforeId: Option[String] = None, limit: Option[String] = None): Future[Page[SshUserCertificateList]]

    List all SSH User Certificates issued on this account

    List all SSH User Certificates issued on this account

    See also https://ngrok.com/docs/api#api-ssh-user-certificates-list.

    beforeId

    the value of the before_id parameter as a scala.Predef.String

    limit

    the value of the limit parameter as a scala.Predef.String

    returns

    a scala.concurrent.Future encapsulating the API call's result

  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. def update(id: String, description: Option[String] = None, metadata: Option[String] = None): Future[SshUserCertificate]

    Update an SSH User Certificate

    Update an SSH User Certificate

    See also https://ngrok.com/docs/api#api-ssh-user-certificates-update.

    id

    the value of the id parameter as a scala.Predef.String

    description

    human-readable description of this SSH User Certificate. optional, max 255 bytes.

    metadata

    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.

    returns

    a scala.concurrent.Future encapsulating the API call's result

  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 SshUserCertificates toStringFormat[SshUserCertificates] 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): (SshUserCertificates, B)
    Implicit
    This member is added by an implicit conversion from SshUserCertificates toArrowAssoc[SshUserCertificates] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromSshUserCertificates to any2stringadd[SshUserCertificates]

Inherited by implicit conversion StringFormat fromSshUserCertificates to StringFormat[SshUserCertificates]

Inherited by implicit conversion Ensuring fromSshUserCertificates to Ensuring[SshUserCertificates]

Inherited by implicit conversion ArrowAssoc fromSshUserCertificates to ArrowAssoc[SshUserCertificates]

Ungrouped