Instance Constructors

1.  new Credential(id: String, uri: URI, createdAt: OffsetDateTime, description: String, metadata: String, token: Option[String] = None, acl: List[String])

   create a new Credential.

   create a new Credential.

   id

   unique tunnel credential resource identifier

   uri

   URI of the tunnel credential API resource

   createdAt

   timestamp when the tunnel credential was created, RFC 3339 format

   description

   human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.

   metadata

   arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.

   token

   the credential's authtoken that can be used to authenticate an ngrok agent. This value is only available one time, on the API response from credential creation, otherwise it is null.

   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.