Sign in
SSHUserCertificates

Update

Update an SSH User Certificate

patch/ssh_user_certificates/{id}

Path parameters

idstring required

Headers

ngrok-versioninteger required

Request body

idstring

n/a

descriptionstring

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

metadatastring

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

Response

Update an SSH User Certificate

idstring

unique identifier for this SSH User Certificate

uristring

URI of the SSH User Certificate API resource

created_atstring

timestamp when the SSH User Certificate API resource was created, RFC 3339 format

descriptionstring

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

metadatastring

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

public_keystring

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

key_typestring

the key type of the public_key, one of rsa, ecdsa or ed25519

ssh_certificate_authority_idstring

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

principalsstring[]

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.

critical_optionsobject

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.

extensionsobject

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.

valid_afterstring

the time when the ssh host certificate becomes valid, in RFC 3339 format.

valid_untilstring

the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.

certificatestring

the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive

Changes

Changed in 1 of the 9 revisions of this API.1

  • e40349f8ec6f1See the full diff
    • ○

      api operation id SSHUserCertificatesUpdate removed and replaced with SshUserCertificatesUpdate

      api-operation-id-removed