• Public
  • Public/Protected
  • All

Interface CredentialUpdate


  • CredentialUpdate




Optional acl

acl: string[]

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.

Optional description

description: string

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


id: string

Optional metadata

metadata: string

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

Generated using TypeDoc