ConvertKey

Trigger this action to write a Crypto Key object to a file in a specific format.

Use the HTTP POST method with the resource /mgmt/actionqueue/default, specifying a request payload with the following format:

{
  "ConvertKey": {
    "ObjectName": "object",
    "OutputFilename": "file",
    "Format": "format"
  }
}

ObjectName: String; Specifies the name of the key alias.
OutputFilename: String; Specifies the output file name. Use the temporary:///mykey.pub format.
Format: String; Specifies the format for the output file. The supported format is openssh-pubkey.

This action converts a private key alias to a specific output format and writes it to a file. If the output format includes private fields of the key, the file must be in the same directory as the configured file of the private key alias.

The openssh-pubkey format can be used in OpenSSH authorized_keys files. The format does not contain any private fields. It contains only public fields.

Example

To save the key named iop_mgmt_key to the file savedthekey.pub, post the following payload to https://yourhost:5554/mgmt/actionqueue/default:

{
  "ConvertKey": {
    "ObjectName": "iop_mgmt_key",
    "OutputFilename": "temporary:///savedthekey.pub",
    "Format": "openssh-pubkey"
  }
}