GetSSHPublicKeyRequest

APIs.ioEngineeringPlatform

Properties

Name Type Description
UserName object
SSHPublicKeyId object
Encoding object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-getsshpublickeyrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetSSHPublicKeyRequest",
  "title": "GetSSHPublicKeyRequest",
  "type": "object",
  "required": [
    "UserName",
    "SSHPublicKeyId",
    "Encoding"
  ],
  "properties": {
    "UserName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/userNameType"
        },
        {
          "description": "<p>The name of the IAM user associated with the SSH public key.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p>"
        }
      ]
    },
    "SSHPublicKeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/publicKeyIdType"
        },
        {
          "description": "<p>The unique identifier for the SSH public key.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters that can consist of any upper or lowercased letter or digit.</p>"
        }
      ]
    },
    "Encoding": {
      "allOf": [
        {
          "$ref": "#/components/schemas/encodingType"
        },
        {
          "description": "Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use <code>SSH</code>. To retrieve the public key in PEM format, use <code>PEM</code>."
        }
      ]
    }
  }
}