Create Custom Key
    • PDF

    Create Custom Key

    • PDF

    Article summary

    POST /kms/v1/keys/{keyTag}/create-custom-key

    Create a randomized raw key that can be utilized as an encryption key. It can only be requested as an AES256 or RSA2048 key type.

    Request

    Request parameters

    Parameter NameTypeAdditional Information
    x-ncp-ocapi-tokenHeader(Required)Access Token
    keyTagPath(Required)
    requestPlainKeyBody: Boolean
    bitsBody: Integer128, 256, 512 (Default = 256)
    contextBody: StringBase64 Encoded text(Up to 50B). Can only be used as a key to apply convergent encryption

    Request body

    {
      "requestPlainKey": true,
      "bits": 0
    }
    

    Response

    Response code: 200

    Response body

    {
      "code": "string",
      "data": {
        "ciphertext": "string",
        "key_version": 0,
        "plaintext": "string"
      }
    }
    

    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.