GPG Key

A unique encryption key

APIs.ioEngineeringPlatform

Properties

Name Type Description
id integer
name string
primary_key_id integer
key_id string
public_key string
emails array
subkeys array
can_sign boolean
can_encrypt_comms boolean
can_encrypt_storage boolean
can_certify boolean
created_at string
expires_at string
revoked boolean
raw_key string
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-gpg-key-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/gpg-key",
  "title": "GPG Key",
  "description": "A unique encryption key",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 3
    },
    "name": {
      "type": "string",
      "example": "Octocat's GPG Key",
      "nullable": true
    },
    "primary_key_id": {
      "type": "integer",
      "nullable": true
    },
    "key_id": {
      "type": "string",
      "example": "3262EFF25BA0D270"
    },
    "public_key": {
      "type": "string",
      "example": "xsBNBFayYZ..."
    },
    "emails": {
      "type": "array",
      "example": [
        {
          "email": "[email protected]",
          "verified": true
        }
      ],
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string"
          },
          "verified": {
            "type": "boolean"
          }
        }
      }
    },
    "subkeys": {
      "type": "array",
      "example": [
        {
          "id": 4,
          "primary_key_id": 3,
          "key_id": "4A595D4C72EE49C7",
          "public_key": "zsBNBFayYZ...",
          "emails": [],
          "can_sign": false,
          "can_encrypt_comms": true,
          "can_encrypt_storage": true,
          "can_certify": false,
          "created_at": "2016-03-24T11:31:04-06:00",
          "expires_at": null,
          "revoked": false
        }
      ],
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "primary_key_id": {
            "type": "integer"
          },
          "key_id": {
            "type": "string"
          },
          "public_key": {
            "type": "string"
          },
          "emails": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "email": {
                  "type": "string"
                },
                "verified": {
                  "type": "boolean"
                }
              }
            }
          },
          "subkeys": {
            "type": "array",
            "items": {}
          },
          "can_sign": {
            "type": "boolean"
          },
          "can_encrypt_comms": {
            "type": "boolean"
          },
          "can_encrypt_storage": {
            "type": "boolean"
          },
          "can_certify": {
            "type": "boolean"
          },
          "created_at": {
            "type": "string"
          },
          "expires_at": {
            "type": "string",
            "nullable": true
          },
          "raw_key": {
            "type": "string",
            "nullable": true
          },
          "revoked": {
            "type": "boolean"
          }
        }
      }
    },
    "can_sign": {
      "type": "boolean",
      "example": true
    },
    "can_encrypt_comms": {
      "type": "boolean"
    },
    "can_encrypt_storage": {
      "type": "boolean"
    },
    "can_certify": {
      "type": "boolean",
      "example": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2016-03-24T11:31:04-06:00"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "revoked": {
      "type": "boolean",
      "example": true
    },
    "raw_key": {
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "id",
    "primary_key_id",
    "key_id",
    "raw_key",
    "public_key",
    "created_at",
    "expires_at",
    "can_sign",
    "can_encrypt_comms",
    "can_encrypt_storage",
    "can_certify",
    "emails",
    "subkeys",
    "revoked"
  ]
}