class CertificateAuthorities extends AnyRef
Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.
See also https://ngrok.com/docs/api#api-certificate-authorities.
- Alphabetic
- By Inheritance
- CertificateAuthorities
- 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 CertificateAuthorities toany2stringadd[CertificateAuthorities] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (CertificateAuthorities, B)
- Implicit
- This member is added by an implicit conversion from CertificateAuthorities toArrowAssoc[CertificateAuthorities] 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(caPem: String, description: Option[String] = None, metadata: Option[String] = None): Future[CertificateAuthority]
Upload a new Certificate Authority
Upload a new Certificate Authority
See also https://ngrok.com/docs/api#api-certificate-authorities-create.
- caPem
raw PEM of the Certificate Authority
- description
human-readable description of this Certificate Authority. optional, max 255 bytes.
- metadata
arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
- returns
a scala.concurrent.Future encapsulating the API call's result
- def delete(id: String): Future[Unit]
Delete a Certificate Authority
Delete a Certificate Authority
See also https://ngrok.com/docs/api#api-certificate-authorities-delete.
- id
a resource identifier
- returns
a scala.concurrent.Future encapsulating the API call's result
- def ensuring(cond: (CertificateAuthorities) => Boolean, msg: => Any): CertificateAuthorities
- Implicit
- This member is added by an implicit conversion from CertificateAuthorities toEnsuring[CertificateAuthorities] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (CertificateAuthorities) => Boolean): CertificateAuthorities
- Implicit
- This member is added by an implicit conversion from CertificateAuthorities toEnsuring[CertificateAuthorities] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): CertificateAuthorities
- Implicit
- This member is added by an implicit conversion from CertificateAuthorities toEnsuring[CertificateAuthorities] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): CertificateAuthorities
- Implicit
- This member is added by an implicit conversion from CertificateAuthorities toEnsuring[CertificateAuthorities] 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[CertificateAuthority]
Get detailed information about a certficate authority
Get detailed information about a certficate authority
See also https://ngrok.com/docs/api#api-certificate-authorities-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[CertificateAuthorityList]]
List all Certificate Authority on this account
List all Certificate Authority on this account
See also https://ngrok.com/docs/api#api-certificate-authorities-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[CertificateAuthority]
Update attributes of a Certificate Authority by ID
Update attributes of a Certificate Authority by ID
See also https://ngrok.com/docs/api#api-certificate-authorities-update.
- id
the value of the
idparameter as a scala.Predef.String- description
human-readable description of this Certificate Authority. optional, max 255 bytes.
- metadata
arbitrary user-defined machine-readable data of this Certificate Authority. 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 CertificateAuthorities toStringFormat[CertificateAuthorities] 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): (CertificateAuthorities, B)
- Implicit
- This member is added by an implicit conversion from CertificateAuthorities toArrowAssoc[CertificateAuthorities] 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.