Create user custom key
    • PDF

    Create user custom key

    • PDF

    Article Summary

    Overview

    It generates a random high-entropy key with the given bits (symmetric keying only). You can also get a key returned in plain text, along with a key sealed with the current version of the specified master key. You can only request a key type for encryption/decryption.

    POST https://kms.apigw.ntruss.com/keys/v1/{keyTag}/createCustomKey
    POST https://kms.apigw.ntruss.com/keys/v2/{keyTag}/createCustomKey
    

    Requests

    Request parameters

    Parameter nameTypeDescription
    keyTagString (Required)Tag value of the master key to use for the generated key seal

    Request bodies

    {
      "requestPlainKey" : boolean,
      "bits" : integer,
      "context": string
    }
    
    Parameter nameTypeDescription
    requestPlainKeyBoolean (Required)Flag to select whether the generated key is returned in plain text
    bitsInteger (Optional)Bits of the key to be generated
    128, 256, 512 (default 256)
    contextString (Optional)Used when a convergent cipher is applied to the master key
    Context data (up to 50 bytes)
    Requires Base64 Encoding

    Responses

    Response bodies

    {
      "plaintext" : string,
      "key_version": integer
      "ciphertext" : string
    }
    
    Parameter nameTypeDescription
    plaintextString- Plain text form of the generated key
    requestPlainKey: Return only if true
    Base64 encoded
    key_versionInteger- Version information of the master key
    ciphertextString- Sealed form of the generated key
    Base64 encoded

    Required access

    Manager, Encryptor, Encryptor/Decryptor


    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.