Crypto Server
    Preparing search index...

    Interface IBodyGenerate

    Request body for the key generation endpoint.

    {
      "name": "Alice",
      "email": "alice@example.com",
      "type": "ecc",
      "passphrase": "s3cret",
      "curve": "curve25519",
      "format": "armored"
    }
    interface IBodyGenerate {
        name: string;
        email: string;
        type: "ecc" | "rsa";
        passphrase: string;
        rsaBits?: number;
        curve:
            | "curve25519"
            | "ed25519"
            | "p256"
            | "p384"
            | "p521"
            | "secp256k1"
            | "brainpoolP256r1"
            | "brainpoolP384r1"
            | "brainpoolP512r1";
        keyExpirationTime?: number;
        format: "object"
        | "binary"
        | "armored";
    }
    Index
    name email type passphrase rsaBits? curve keyExpirationTime? format
    name: string

    Display name embedded in the key's user ID.

    email: string

    Email address embedded in the key's user ID.

    type: "ecc" | "rsa"

    Key algorithm family.

    passphrase: string

    Passphrase used to protect the private key.

    rsaBits?: number

    RSA modulus size in bits (only used when type is "rsa").

    curve:
        | "curve25519"
        | "ed25519"
        | "p256"
        | "p384"
        | "p521"
        | "secp256k1"
        | "brainpoolP256r1"
        | "brainpoolP384r1"
        | "brainpoolP512r1"

    Elliptic curve name (only used when type is "ecc").

    keyExpirationTime?: number

    Key expiration time in seconds from creation (0 = never).

    format: "object" | "binary" | "armored"

    Output format for the generated key material.

    Settings
    Member Visibility

    On This Page
    Properties