timestamp when the ssh credential was created, RFC 3339 format
human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
unique ssh credential resource identifier
arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
the PEM-encoded public key of the SSH keypair that will be used to authenticate
URI of the ssh credential API resource
Generated using TypeDoc
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. Thebind
rule allows the caller to restrict what domains, addresses, and labels 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 rulebind:example.ngrok.io
. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule ofbind:*.example.com
which will allowx.example.com
,y.example.com
,*.example.com
, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule ofbind:*=example
which will allowx=example
,y=example
, etc. A rule of'*'
is equivalent to no acl at all and will explicitly permit all actions.