To find the existing attributes for the security object, run the okv managed-object attribute list command. If you want to create a custom attribute, then use the okv managed-object custom-attribute add command.

Required Authorization

The endpoint must have read-modify permission on the object.

Syntax

 okv managed-object attribute add [--activation-date activation date] [--contact-info contact information] [--deactivation-date deactivation date] [--name name] [--process-start-date process start date] [--protect-stop-date protect stop date] --uuid uuid

You may use the JSON syntax for this command to specify the attributes with the --uuid parameter specified at the command line. This is useful for cases where you want to apply the same attribute values to multiple objects. You can re-use the same JSON file and specify different UUIDs at the command line.

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "add",
    "options" : {
      "uuid" : "#VALUE",
      "attributes" : {
        "name" : {
        "value" : "#VALUE",
        "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      }
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object attribute add command and save it.

   okv managed-object attribute add --generate-json-input 

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "attribute",
       "action" : "add",
       "options" : {
         "uuid" : "#VALUE",
         "attributes" : {
          "name" : {
            "value" : "#VALUE",
            "type" : "#text|uri"
            },
           "contactInfo" : "#VALUE",
           "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
         }
       }
     }
   }

2. Save the generated input to a file (for example, add_attribute.json) and then edit it to include the attributes for the security object. For example:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "attribute",
       "action" : "add",
       "options" : {
         "uuid" : "2359E04F-DA61-4F7C-BF9F-913D3369A93A",
         "attributes" : {
           "contactInfo" : "psmith@example.com",
           "deactivationDate" : "2024-12-31 09:00:00",
           "name" : {
            "value" : "PROD-HRDB-MKEY",
            "type" : "text"
            },
          "protectStopDate" : "2024-09-30 09:00:00"
         }
       }
     }
   }

3. Run the okv managed-object attribute add command using the generated JSON file.

   okv managed-object attribute add --from-json add_attribute.json

   Output similar to the following appears:

   {
     "result" : "Success",
     "value" : {
       "attributes" : {
         "contactInfo" : "Added",
         "deactivationDate" : "Added",
         "name" : "Added",
         "protectStopDate" : "Added"
         }
      }    
    }

Required Authorization

The endpoint must have read-modify permission on the object.

Syntax

okv managed-object attribute delete [--activation-date] [--contact-info] [--deactivation-date]
             [--name name] [--process-start-date] [--protect-stop-date] --uuid uuid

You may use the JSON syntax for this command to specify the attributes with the --uuid parameter specified at the command line. This is useful for cases where you want to apply the same attribute values to multiple objects. You can re-use the same JSON file and specify different UUIDs at the command line.

JSON Input File Template

{
  "service": {
    "category": "managed-object",
    "resource": "attribute",
    "action": "delete",
    "options": {
      "uuid": "#VALUE",
      "attributes": {
        "name": {
          "value": "#VALUE"
        },
        "contactInfo": "#VALUE",
        "activationDate": "#VALUE",
        "deactivationDate": "#VALUE",
        "protectStopDate": "#VALUE",
        "processStartDate": "#VALUE"
      }
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object attribute delete command.

   okv managed-object attribute delete --generate-json-input

   The generated input appears as follows:

   {
     "service": {
       "category": "managed-object",
       "resource": "attribute",
       "action": "delete",
       "options": {
         "uuid": "#VALUE",
         "attributes": {
           "name": {
             "value": "#VALUE"
           },
           "contactInfo": "#VALUE",
           "activationDate": "#VALUE",
           "deactivationDate": "#VALUE",
           "protectStopDate": "#VALUE",
           "processStartDate": "#VALUE"
         }
       }
     }
   }

2. Save the generated input to a file (for example, del_attribute.json) and then edit it so that you can delete the attributes associated with a security object.

   {
     "service": {
       "category": "managed-object",
       "resource": "attribute",
       "action": "delete",
       "options": {
         "uuid": "2359E04F-DA61-4F7C-BF9F-913D3369A93A",
         "attributes": {
           "name": {
             "value": "PROD-HRDB-MKEY"
           }
         }
       }
     }
   }

3. Run the okv managed-object attribute delete command using the generated JSON file.

   okv managed-object attribute delete --from-json del_attribute.json

   Output similar to the following appears:

   {
     "result": "Success",
     "value": {
       "attributes": {
         "name": "Deleted"
       }
     }
   }

Required Authorization

The endpoint must have read permission on the object.

Syntax

okv managed-object attribute get [--activation-date] [--archive-date] [--certificate-length] [--certificate-type]
 [--compromise-date] [--compromise-occurrence-date] [--contact-info] [--crypto-usage-mask] [--cryptographic-algorithm]
 [--cryptographic-length][--custom-attribute] [--custom-attributes custom attributes] [--deactivation-date] [--destroy-date]
 [--digest] [--digital-signing-algorithm ][--extractable] [--initial-date] [--last-change-date] [--link] [--name][--never-extractable]
 [--object-group-member] [--object-type][- -process-start-date] [--protect-stop-date] [--state] --uuid [uuid] [--x509-certificate-issuer]
 [--x509-certificate-subject]

You may use the JSON syntax for this command to specify the attributes with the --uuid parameter specified at the command line. This is useful for cases where you want to apply the same attribute values to multiple objects. You can re-use the same JSON file and specify different UUIDs at the command line.

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE",
      "attributes" : [ "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME"],
      "customAttributes" : [ "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME" ]
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object attribute get command.

   okv managed-object attribute get --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "attribute",
       "action" : "get",
       "options" : {
         "uuid" : "#VALUE",
         "attributes" : [ "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME" ],
         "customAttributes" : [ "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME" ]
       }
     }
   }

2. Save the generated input to a file (for example, get_attribute.json) and then edit it to retrieve the attributes associated with the security object.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "attribute",
       "action" : "get",
       "options" : {
          "uuid": "2359E04F-DA61-4F7C-BF9F-913D3369A93A",
          "attributes": [
            "activationDate",
            "contactInfo",
            "cryptoUsageMask",
            "cryptographicAlgorithm",
            "cryptographicLength",
            "name",
            "objectType",
            "state",
            "extractable",
            "neverExtractable"
         ],
         "customAttributes" : ["x-ApplicationTag"]
       }
     }
   }

3. Run the okv managed-object attribute get command using the generated JSON file.

   okv managed-object attribute get --from-json get_attribute.json

   Output similar to the following appears:

   {
     "result": "Success",
     "value": {
       "attributes": {
         "activationDate": "2020-11-21 01:00:00",
         "contactInfo": "psmith@example.com",
         "cryptoUsageMask": [
           "ENCRYPT",
           "DECRYPT"
         ],
         "cryptographicAlgorithm": "AES",
         "cryptographicLength": "256",
         "extractable" : "false",
         "name": [
           {
             "type": "text",
             "value": "PROD-HRDB-MKEY"
           }
         ],
         "neverExtractable" : "TRUE",
         "objectType": "Symmetric Key",
         "state": "Active"
       },
       "customAttributes": [
         {
           "index": "1",
           "name": "x-ApplicationTag",
           "type": "Text String",
           "value": "HR-Production"
         }
       ]
     }
   }
   

Required Authorization

The endpoint must have read permission on the object.

Syntax

okv managed-object attribute get-all --uuid UUID

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "get-all",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object attribute get-all command.

   okv managed-object attribute get-all --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "attribute",
       "action" : "get-all",
       "options" : {
         "uuid" : "#VALUE"
       }
     }
   }

2. Save the generated input to a file (for example, get_all_attributes.json) and then edit it to get all the attributes of the security object.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "attribute",
       "action" : "get-all",
       "options" : {
         "uuid" : "2359E04F-DA61-4F7C-BF9F-913D3369A93A"
       }
     }
   }

3. Run the okv managed-object attribute get-all command using the generated JSON file.

   okv managed-object attribute get-all --from-json get_all_attributes.json

   Output similar to the following appears:

   {  
     "result" : "Success",  "value" : {
       "attributes" : {
         "activationDate" : "2022-10-28 18:58:34",
         "cryptoUsageMask" : [ "SIGN" ],
         "cryptographicAlgorithm" : "RSA",
         "cryptographicLength" : "2048",
         "digest" : {
           "algorithm" : "SHA-256",
           "digestValue" : "9E6C6718C34FE44E3C91558CB83278CEC0706B8906BF0DED23A6117DC9EE6CD0",
           "keyFormatType" : "RAW"
         },
         "extractable" : "false",
         "fresh" : "Yes",
         "initialDate" : "2022-10-28 18:58:36",
         "lastChangeDate" : "2022-10-28 18:58:38",
         "neverExtractable" : "true",
         "objectType" : "Private Key",
         "processStartDate" : "2022-10-28 18:58:36",
         "state" : "Active",
         "uuid" : "06024832-066A-4F02-BF03-FA5B09E9A6AF"
       }
     }
   }

The okv managed-object attribute list command shows the key customAttributes if the object has one or more custom attributes. To find the custom attributes defined for the object, run the okv managed-object attribute get-all command.

Required Authorization

The endpoint must have read permission on the object.

Syntax

okv managed-object attribute list --uuid UUID

JSON Input File Template

{
  "service": {
    "category": "managed-object",
    "resource": "attribute",
    "action": "list",
    "options": {
      "uuid": "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object attribute list command.

   okv managed-object attribute list --generate-json-input

   The generated input appears as follows:

   {
     "service": {
       "category": "managed-object",
       "resource": "attribute",
       "action": "list",
       "options": {
         "uuid": "#VALUE"
       }
     }
   }

2. Save the generated input to a file (for example, list_attributes.json) and then edit it to retrieve the list of attributes for the security object.

   {
     "service": {
       "category": "managed-object",
       "resource": "attribute",
       "action": "list",
       "options": {
         "uuid": "2359E04F-DA61-4F7C-BF9F-913D3369A93A"
       }
     }
   }

3. Run the okv managed-object attribute list command using the generated JSON file.

   okv managed-object attribute list --from-json list_attributes.json

   Output similar to the following appears:

   {
     "result": "Success",
     "value": {
        "attributes" : [
            "activationDate",
            "contactInfo",
            "cryptoUsageMask",
            "cryptographicAlgorithm",
            "cryptographicLength",
            "deactivationDate",
            "digest",
            "extractable",
            "fresh",
            "initialDate",
            "lastChangeDate",
            "name",
            "neverExtractable", 
            "objectType",
            "processStartDate",
            "protectStopDate",
            "state"
            "uuid"
         ],
        "customAttributes" : [ "x-ApplicationTag" ]
     }
   }
   

To find the existing attributes for the managed object, run the okv managed-object attribute list command.

Required Authorization

The endpoint must have read-modify permission on the object.

Syntax

okv managed-object attribute modify [--activation-date activation date] [--contact-info contact information]
    [--deactivation-date deactivation date] [--name name] [--process-start-date process start date] 
    [--protect-stop-date protect stop date] --uuid uuid

You may use the JSON syntax for this command to specify the attributes with the --uuid parameter specified at the command line. This is useful for cases where you want to apply the same attribute values to multiple objects. You can re-use the same JSON file and specify different UUIDs at the command line.

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "modify",
      "options" : {
        "uuid" : "#VALUE",
        "attributes" : {
          "name" : {
            "value" : "#VALUE",
            "newValue" : "#VALUE",
            "newType" : "#text|uri"
                },
            "contactInfo" : "#VALUE",
            "activationDate" : "#VALUE",
            "deactivationDate" : "#VALUE",
            "protectStopDate" : "#VALUE",
            "processStartDate" : "#VALUE",
            "extractable" : "#TRUE|FALSE"
           }
        }
      }
   }

Parameters

JSON Example

1. Generate JSON input for the okv managed-object attribute modify command.

   okv managed-object attribute modify --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "attribute",
       "action" : "modify",
       "options" : {
         "uuid" : "#VALUE",
         "attributes" : {
           "name" : {
             "value" : "#VALUE",
             "newValue" : "#VALUE",
             "newType" : "#text|uri"
           },
           "contactInfo" : "#VALUE",
           "activationDate" : "#VALUE",
           "deactivationDate" : "#VALUE",
           "protectStopDate" : "#VALUE",
           "processStartDate" : "#VALUE",
           "extractable" : "#TRUE|FALSE"
         }
       }
     }
   }

2. Save the generated input to a file (for example, modify_attributes.json) and then edit it to modify the attributes that are associated with the security object.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "attribute",
       "action" : "modify",
       "options" : {
         "uuid" : "2359E04F-DA61-4F7C-BF9F-913D3369A93A",
         "attributes" : {
           "name" : {
             "value" : "PROD-HRDB-MKEY",
             "newValue" : "PROD-GLOBAL-HRDB-MKEY",
             "newType" : "text"
           },
           "contactInfo" : "jscott@example.com",
           "deactivationDate" : "2024-07-31 09:00:00",
           "protectStopDate" : "2024-04-30 09:00:00",
           "extractable" : "FALSE"
         }
       }
     }
   }

3. Run the okv managed-object attribute modify command using the generated JSON file.

   okv managed-object attribute modify --from-json modify_attributes.json

   Output similar to the following appears:

   {
        "result": "Success",
        "value": {
         "attributes": {
          "contactInfo": "Modified",
          "deactivationDate": "Modified",
          "name": "Modified",
          "protectStopDate": "Modified",
          "extractable" : "Modified"
       }
     }
   }

Required Authorization

The endpoint must have read permission on the certificate object.

Syntax

okv managed-object certificate get --output_format <text|json> --uuid UUID

JSON Input File Template

{
  "service": {
    "category": "managed-object",
    "resource": "certificate",
    "action": "get",
    "options": {
      "uuid": "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object certificate get command.

   okv managed-object certificate get --generate-json-input

   The generated input appears as follows:

   {
     "service": {
       "category": "managed-object",
       "resource": "certificate",
       "action": "get",
       "options": {
         "uuid": "#VALUE"
       }
     }
   }

2. Save the generated input to a file (for example, get_cert.json) and then edit it to retrieve the specified certificate.

   {
     "service": {
       "category": "managed-object",
       "resource": "certificate",
       "action": "get",
       "options": {
         "uuid": "EEED2C4F-33D7-4F9A-BF02-52DD2225A43A"
       }
     }
   }

3. Run the okv managed-object certificate get command using the generated JSON file.

   okv managed-object certificate get --from-json get_cert.json

   Output similar to the following appears:

   {
    "result": "Success",
     "value": {
      "object": "-----BEGIN CERTIFICATE-----\nMIIDdzCCAl+gAwIBAgICfVEwDQYJKoZIhvcNAQELBQAwazELMAkGA1UEBhMCdXMx\nEzARB << output truncated >> AYP\n4vwrDwBdNdGtj36GqjuCpz/xCVM9ieSRxJU8\n-----END CERTIFICATE-----"
     } 
   }

Example Using Text as Output Format

okv managed-object certificate get --output_format text --uuid EEED2C4F-33D7-4F9A-BF02-52DD2225A43A

Output

Output similar to the following appears:

-----BEGIN CERTIFICATE-----
MIIDfDCCAmSgAwIBAgICVN0wDQYJKoZIhvcNAQELBQAwazELMAkGA1UEBhMCdXMx
EzARBgNVBAgTCkNhbGlmb3JuaWExFTATBgNVBAcMDFJlZHdvb2RfQ2l0eTEPMA0G
A1UEChMGT3JhY2xlMRIwEAYDVQQLDAlLZXlfVmF1bHQxCzAJBgNVBAMTAkNBMB4X
DTI0MDQwMjIxMzg0MloXDTI1MDQwMjIxMzg0MlowczELMAkGA1UEBhMCdXMxEzAR
BgNVBAgTCkNhbGlmb3JuaWExFTATBgNVBAcMDFJlZHdvb2RfQ2l0eTEPMA0GA1UE
ChMGT3JhY2xlMRIwEAYDVQQLDAlLZXlfVmF1bHQxEzARBgNVBAMTCllUS3hVQUNn
UFAwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDs/j10tz0hNX7tZQn3
S7I7lA7OkNO0eKiQWUThs/gvE+ARQlHC9xaRIONIFmLN41bQQdOQ4wWLDTv8CIK9
QgxldPdyVoTqV5D6x+kSfqI/BPuWvKyvIXuErr1XM/2LBh63Pu/2DXXDsmZK5BZn
wQrQ4iz/OjA8pG0gpboJJKnvVDzhul0z6lwvuVWLGwTqRwwXovlc/VF5/G5KReW0
stIZAfvpPtG/vlCbMd+LgGGyqUwWmdpTf7s0MMX1+kQ10vT4lV7jBNbLKl8u21bv
0d7Gt5Gqbh1+VLUEU/2tg+G2i8nMI3U0wc1IU2ndNV/YytzILg11AAYWvYikFiui
WwejAgMBAAGjIjAgMB4GA1UdEQQXMBWHBAr0QMaCDTEwLjI0NC42NC4xOTgwDQYJ
KoZIhvcNAQELBQADggEBADRzbI0uxExK2WlNNnFilLH/MmQVa2rMKybCFsiHiNjf
Rseq1Tm+qIYQlosaceIVw/lQLineVt73eXFhS66O01qPk2sG0WGRB08/BiQvDv2V
KwYJ5I9EVzILCmGeMCOLsdbNlodBiDcWBOubbbiyDShStgjEddoiVizfmfjeCUq2
sSN3hr4tgTZupgNA1RB9n+krBrSbR16aMbmrjqEubaBywnQNMiNLid7uRx243p96
WNup2dzGiuTJYyyRtbjpTPz1ZCQhqi5DsVFrclvH2V/EZj4rcLg/BS0cBcEc2gc/
9aYwIPbClN8Cj1bOGBQ66DvXVPBRNMfW5s8cWoX8JU4=
-----END CERTIFICATE-----
  

Required Authorization

None

Syntax

okv managed-object certificate register [--activation-date activation date] [--algorithm algorithm] [--custom-attribute custom attribute]
       [--deactivation-date deactivation date] [--length length] [--mask mask] [--name name] --object object [--private-key-uuid
       private-key-uuid] [--sub-type sub-type] [--type type] [--wallet wallet]

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "certificate",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "algorithm" : "#RSA",
      "length" : "#1024,2048,3072,4096(RSA)",
      "mask" : [ "#VERIFY", "#EXPORT" ],,
      "type" : "X_509",
      "subType" : "#USER_CERT|TRUSTPOINT",
      "privateKeyUUID" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

Parameters

CLI Example

okv managed-object certificate register --type X_509 --private-key-uuid 
95092BD2-B546-4F9A-BF0B-D8ECDC548546 --algorithm RSA --mask "VERIFY" --object
/Users/dopark/test/my.crt --name cert_0701 --activation-date now
--deactivation-date "2030-10-10 10:10:10

JSON Example

1. Generate JSON input for the okv managed-object certificate register command.

   okv managed-object certificate register --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "certificate",
       "action" : "register",
       "options" : {
         "object" : "#VALUE",
         "algorithm" : "#RSA",
         "length" : "#1024,2048,3072,4096(RSA)",
         "mask" : [ "#VERIFY", "#EXPORT" ],
         
         "type" : "X_509",
         "subType" : "#USER_CERT|TRUSTPOINT",
         "privateKeyUUID" : "#VALUE",
         "wallet" : "#VALUE",
         "attributes" : {
           "name" : {
             "value" : "#VALUE",
             "type" : "#text|uri"
           },
           "contactInfo" : "#VALUE",
           "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
         },
         "customAttributes" : [ {
           "name" : "#VALUE",
           "value" : "#VALUE",
           "type" : "#TEXT|NUMBER"
         } ]
       }
     }
   }

2. Save the generated input to a file (for example, reg_cert.json) and then edit it to register the specified certificate.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "certificate",
       "action" : "register",
       "options" : {
         "object" : "./cert.pem",
         "algorithm" : "RSA",
         "length" : "2048",
         "mask" : [ "VERIFY"],
         "type" : "X_509",
         "subType" : "USER_CERT",
         "privateKeyUUID" : "D497994E-74CD-4F60-BF7C-52F254142705",
         "wallet" : "hr_wallet",
         "attributes" : {
           "name" : {
             "value" : "FINDB-PROD-CERT",
             "type" : "text"
           },
           "contactInfo" : "psmith@example.com"
           "activationDate" : "2020-12-31 09:00:00",
           "deactivationDate" : "2024-12-31 09:00:00",
           "processStartDate" : "2020-12-31 09:00:00",
           "protectStopDate" : "2024-12-31 09:00:00"
         }
       }
     }
   }

3. Run the okv managed-object certificate register command using the generated JSON file.

   okv managed-object certificate register --from-json reg_cert.json

   Output similar to the following appears:

   {
    "result" : "Success",
     "value" : {
     "uuid" : "EEED2C4F-33D7-4F9A-BF02-52DD2225A43A"
     }
   }

Example Using Text as Output Format

okv managed-object certificate register --output_format text --object certificate_file_path --type certificate_type --sub-type certificate_sub_type --algorithm cryptographic_algorithm --length key_length --mask cryptographic_usage_mask --private-key-uuid private_key_uuid  --wallet wallet_name

Output

Output similar to the following appears:

"EEED2C4F-33D7-4F9A-BF02-52DD2225A43A"
  

Required Authorization

The endpoint must have read permission on the certificate request object.

Syntax

okv managed-object certificate-request get --output_format <text|json> --uuid UUID

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "certificate-request",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object certificate-request get command.

   okv managed-object certificate-request get  --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "certificate-request",
       "action" : "get",
       "options" : {
         "uuid" : "#VALUE"
       }
     }
   }

2. Save the generated input to a file (for example, get_cert_req.json) and then edit it to specify the UUID of the certificate request.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "certificate-request",
       "action" : "get",
       "options" : {
         "uuid" : "BC0E9004-82E0-4FFA-BFF2-29A67DDD5C64"
       }
     }
   }

3. Run the okv managed-object certificate-request get command using the generated JSON file.

   okv managed-object certificate-request get  --from-json get_cert_req.json

   Output similar to the following appears:

   {
        "result" : "Success",
        "value" : {
         "object" : "-----BEGIN NEW CERTIFICATE REQUEST-----\nMIIC5TCCAc0CAQAwdDELMAkGA1UEBhMCdXMxEzARBgNVBAgTCkNhbGlmb3JuaWEx << output truncated >> \nDtWoeZfNYHcWPFmHK8aiLCgzeFG62xRdyg==\n-----END NEW CERTIFICATE REQUEST-----"
         }
       }

Example Using Text as Output Format

okv managed-object certificate-request get --output_format text --uuid BC0E9004-82E0-4FFA-BFF2-29A67DDD5C64

Output

Output similar to the following appears:

-----BEGIN NEW CERTIFICATE REQUEST-----
MIIC6TCCAdECAQAwczELMAkGA1UEBhMCdXMxEzARBgNVBAgTCkNhbGlmb3JuaWEx
FTATBgNVBAcMDFJlZHdvb2RfQ2l0eTEPMA0GA1UEChMGT3JhY2xlMRIwEAYDVQQL
DAlLZXlfVmF1bHQxEzARBgNVBAMTCllUS3hVQUNnUFAwggEiMA0GCSqGSIb3DQEB
AQUAA4IBDwAwggEKAoIBAQDs/j10tz0hNX7tZQn3S7I7lA7OkNO0eKiQWUThs/gv
E+ARQlHC9xaRIONIFmLN41bQQdOQ4wWLDTv8CIK9QgxldPdyVoTqV5D6x+kSfqI/
BPuWvKyvIXuErr1XM/2LBh63Pu/2DXXDsmZK5BZnwQrQ4iz/OjA8pG0gpboJJKnv
VDzhul0z6lwvuVWLGwTqRwwXovlc/VF5/G5KReW0stIZAfvpPtG/vlCbMd+LgGGy
qUwWmdpTf7s0MMX1+kQ10vT4lV7jBNbLKl8u21bv0d7Gt5Gqbh1+VLUEU/2tg+G2
i8nMI3U0wc1IU2ndNV/YytzILg11AAYWvYikFiuiWwejAgMBAAGgMTAvBgkqhkiG
9w0BCQ4xIjAgMB4GA1UdEQQXMBWHBAr0QMaCDTEwLjI0NC42NC4xOTgwDQYJKoZI
hvcNAQELBQADggEBAEkyFWs4O5AL8wbG1fJbfcOiXla9htESxqvxc+13/cpvnh1X
akifbJHIM/KNWtGo7Y4m/9ZZo+gbOQmLQgqaDVBbzlM7e0J0h6q3PITMqS3NyNcd
DS8lHaBX82Gv5MldIZcQ972JGXG/bkMuCy+XxtCTH7n7teFEmMZW3RJ0tGtmE16I
VzrIMcv7R2thKWRKI4YeTEltKukt8nOTfF1xRtfk4i4qyVJDLvOsU7aq+NqnXW3r
i1/SdCTkkP/lej/PovpFlzHQf9dFklc39vqTuHPXpWJGqe1uydhEVODB8DQlS6hf
n94/8z3OB4cLiiZGC4jFoKYBFabGYzhCoDtdckM=
-----END NEW CERTIFICATE REQUEST-----
  

Required Authorization

None

Syntax

okv managed-object certificate-request register [--activation-date activation date] [--custom-attribute custom attribute]
       [--deactivation-date deactivation date] [--name name] --object object --private-key-uuid private-key-uuid [--type type] [--wallet
       wallet]

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "certificate-request",
    "action" : "register",
    "options" : {
      "type" : "#CRMF,PKCS10,PEM,PGP",
      "object" : "#VALUE",
      "privateKeyUUID" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

Parameters

CLI Example

okv managed-object certificate-request register --name "FINDB-PROD-CERTREQ" --custom-attribute "x-local-name:HR" --activation-date "2020-12-31 09:00:00" --deactivation-date "2024-12-31 09:00:00

JSON Example

1. Generate JSON input for the okv managed-object certificate-request register command.

   okv managed-object certificate-request register --generate-json-input

   The generated input appears as follows:

   "service" : {
       "category" : "managed-object",
       "resource" : "certificate-request",
       "action" : "register",
       "options" : {
         "type" : "#CRMF,PKCS10,PEM,PGP",
         "object" : "#VALUE",
         "privateKeyUUID" : "#VALUE",
         "wallet" : "#VALUE",
         "attributes" : {
           "name" : {
             "value" : "#VALUE",
             "type" : "#text|uri"
           },
           "contactInfo" : "#VALUE",
           "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
         },
         "customAttributes" : [ {
           "name" : "#VALUE",
           "value" : "#VALUE",
           "type" : "#TEXT|NUMBER"
         } ]
       }
     }
   }
   
   

2. Save the generated input to a file (for example, reg_cert_req.json) and then edit it to specify the appropriate certificate request values.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "certificate-request",
       "action" : "register",
       "options" : {
         "type" : "PEM",
         "object" : "./cert_req.pem",
         "privateKeyUUID" : "D497994E-74CD-4F60-BF7C-52F254142705",
         "wallet" : "hr_wallet",
         "attributes" : {
           "name" : {
             "value" : "FINDB-PROD-CERTREQ",
             "type" : "text"
           },
           "contactInfo" : "psmith@example.com"
           "activationDate" : "2020-12-31 09:00:00",
           "deactivationDate" : "2024-12-31 09:00:00",
           "processStartDate" : "2020-12-31 09:00:00",
           "protectStopDate" : "2024-12-31 09:00:00"
         }
       }
     }
   }

3. Run the okv managed-object certificate-request register command using the generated JSON file.

   okv managed-object certificate-request register --from-json reg_cert_req.json

   Output similar to the following appears:

   {
     "result" : "Success",
      "value" : {
       "uuid" : "BC0E9004-82E0-4FFA-BFF2-29A67DDD5C64"
      }
       }

Example Using Text as Output Format

okv managed-object  certificate-request register --output_format text --object "./cert_req.pem" --type "PEM" --private-key-uuid
      "D497994E-74CD-4F60-BF7C-52F254142705" --wallet hr_wallet  --activation-date now --name hr_csr --custom-attribute "x-local-name:HR"

Output

Output similar to the following appears:

"BC0E9004-82E0-4FFA-BFF2-29A67DDD5C64"
  

Required Authorization

The endpoint must have read-modify permission on the object.

Syntax

okv managed-object custom-attribute add --custom-attribute custom attribute --uuid uuid

You may use the JSON syntax for this command to specify the attributes with the --uuid parameter specified at the command line. This is useful for cases where you want to apply the same attribute values to multiple objects. You can re-use the same JSON file and specify different UUIDs at the command line.

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "custom-attribute",
    "action" : "add",
    "options" : {
      "uuid" : "#VALUE",
      "customAttribute" : {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      }
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object custom-attribute add command.

   okv managed-object custom-attribute add --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "custom-attribute",
       "action" : "add",
       "options" : {
         "uuid" : "#VALUE",
         "customAttribute" : {
           "name" : "#VALUE",
           "value" : "#VALUE",
           "type" : "#TEXT|NUMBER"
         }
       }
     }
   }

2. Save the generated input to a file (for example, add_cust_attr.json) and then edit it to include the custom attribute to the security object.

   {
     "service": {
       "category": "managed-object",
       "resource": "custom-attribute",
       "action": "add",
       "options": {
         "uuid": "3C695846-BB8D-4FD2-BFC4-E646ACB60404",
         "customAttribute": {
           "name": "x-ApplicationTag",
           "value": "HR-Production",
           "type": "TEXT"
         }
       }
     }
   }

3. Run the okv managed-object custom-attribute add command using the generated JSON file.

   okv managed-object custom-attribute add --from-json add_cust_attr.json

   Output similar to the following appears:

   {
    "result" : "Success"
   }

Required Authorization

The endpoint must have read-modify permission on the object.

Syntax

 okv managed-object custom-attribute delete --custom-attribute custom attribute --uuid uuid

You may use the JSON syntax for this command to specify the attributes with the --uuid parameter specified at the command line. This is useful for cases where you want to apply the same attribute values to multiple objects. You can re-use the same JSON file and specify different UUIDs at the command line.

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "custom-attribute",
    "action" : "delete",
    "options" : {
      "uuid" : "#VALUE",
      "customAttribute" : {
        "name" : "#VALUE",
        "index" : "#VALUE"
      }
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object custom-attribute delete command.

   okv managed-object custom-attribute delete --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "custom-attribute",
       "action" : "delete",
       "options" : {
         "uuid" : "#VALUE",
         "customAttribute" : {
           "name" : "#VALUE",
           "index" : "#VALUE"
         }
       }
     }
   }

2. Save the generated input to a file (for example, del_cust_attr.json) and then edit it so that you can delete the custom attribute.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "custom-attribute",
       "action" : "delete",
       "options" : {
         "uuid" : "2359E04F-DA61-4F7C-BF9F-913D3369A93A",
         "customAttribute" : {
           "name" : "x-ApplicationTag",
           "index" : "1"
         }
       }
     }
   }

3. Run the okv managed-object custom-attribute delete command using the generated JSON file.

   okv managed-object custom-attribute delete --from-json del_cust_attr.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

The endpoint must have read-modify permission on the object.

Syntax

 okv managed-object custom-attribute modify --custom-attribute <custom attribute> --uuid <uuid>

You may use the JSON syntax for this command to specify the attributes with the --uuid parameter specified at the command line. This is useful for cases where you want to apply the same attribute values to multiple objects. You can re-use the same JSON file and specify different UUIDs at the command line.

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "custom-attribute",
    "action" : "modify",
    "options" : {
      "uuid" : "#VALUE",
      "customAttribute" : {
        "name" : "#VALUE",
        "newValue" : "#VALUE",
        "index" : "#VALUE"
      }
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object custom-attribute modify command.

   okv managed-object custom-attribute modify --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "custom-attribute",
       "action" : "modify",
       "options" : {
         "uuid" : "#VALUE",
         "customAttribute" : {
           "name" : "#VALUE",
           "newValue" : "#VALUE",
           "index" : "#VALUE"
         }
       }
     }
   }

2. Save the generated input to a file (for example, modify_cust_attr.json) and then edit it to modify the custom attribute.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "custom-attribute",
       "action" : "modify",
       "options" : {
         "uuid" : "2359E04F-DA61-4F7C-BF9F-913D3369A93A",
         "customAttribute" : {
           "name" : "x-ApplicationTag",
           "newValue" : "Global-HR-Production",
           "index" : "1"
         }
       }
     }
   }

3. Run the okv managed-object custom-attribute modify command using the generated JSON file.

   okv managed-object custom-attribute modify --from-json modify_cust_attr.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

None

Syntax

okv managed-object key create [--activation-date activation date] [--algorithm algorithm]
 [--custom-attribute custom attribute][--deactivation-date deactivation date] [--extractable extractable]
 [--length length] [--mask mask] [--name name] [--wallet wallet]

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "key",
    "action" : "create",
    "options" : {
      "algorithm" : "#3DES|AES",
      "length" : "#112,168(3DES)|128,192,256(AES)",
      "mask" : [ "#ENCRYPT", "#DECRYPT", "#WRAP_KEY", "#SIGN", "#VERIFY",
                 "#UNWRAP_KEY", "#EXPORT", "#DERIVE_KEY", "#GENERATE_CRYPTOGRAM",
                 "#VALIDATE_CRYPTOGRAM", "#TRANSLATE_ENCRYPT", "#TRANSLATE_DECRYPT", 
                 "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "extractable" : "#TRUE|FALSE"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

Parameters

Example without using JSON

okv managed-object key create --length 128 --algorithm AES --mask"ENCRYPT" --name  dw_0706

JSON Example

1. Generate JSON input for the okv managed-object key create command.

   okv managed-object key create --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "key",
       "action" : "create",
       "options" : {
         "algorithm" : "#3DES|AES",
         "length" : "#112,168(3DES)|128,192,256(AES)",
         "mask" : [ "#ENCRYPT", "#DECRYPT", "#SIGN", "#VERIFY", "#WRAP_KEY", "#UNWRAP_KEY",
                    "#EXPORT", "#DERIVE_KEY", "#GENERATE_CRYPTOGRAM", 
                    "#VALIDATE_CRYPTOGRAM", "#TRANSLATE_ENCRYPT", "#TRANSLATE_DECRYPT",
                    "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
         "wallet" : "#VALUE",
         "attributes" : {
           "name" : {
             "value" : "#VALUE",
             "type" : "#text|uri"
           },
           "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "extractable" : "#TRUE|FALSE"
         },
         "customAttributes" : [ {
           "name" : "#VALUE",
           "value" : "#VALUE",
           "type" : "#TEXT|NUMBER"
         } ]
       }
     }
   }

2. Save the generated input to a file (for example, create_key.json) and then edit it to create the key.

   {
     "service": {
       "category": "managed-object",
       "resource": "key",
       "action": "create",
       "options": {
         "algorithm": "AES",
         "length": "256",
         "mask": [
           "ENCRYPT",
           "DECRYPT"
         ],
         "wallet": "hr_wallet",
         "attributes": {
            "extractable" : "FALSE"
         }
       }
     }
   }

3. Run the okv managed-object key create command using the generated JSON file.

   okv managed-object key create --from-json create_key.json

   Output similar to the following appears:

   {
     "result": "Success",
      "value": {
       "uuid": "2359E04F-DA61-4F7C-BF9F-913D3369A93A"
     }
   }

Example Using Text as Output Format

okv managed-object key create --extractablefalse --output_format text --algorithm  cryptographic_algorithm --length key_length --mask crypographic_usage_mask --wallet wallet_name

Output

Output similar to the following appears:

"2359E04F-DA61-4F7C-BF9F-913D3369A93A"
  

Required Authorization

The endpoint must have read permission on the key object.

Syntax

okv managed-object key get --output_format text|json --uuid UUID

JSON Input File Template

{
  "service": {
    "category": "managed-object",
    "resource": "key",
    "action": "get",
    "options": {
      "uuid": "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object key get command.

   okv managed-object key get --generate-json-input

   The generated input appears as follows:

   {
     "service": {
       "category": "managed-object",
       "resource": "key",
       "action": "get",
       "options": {
         "uuid": "#VALUE"
       }
     }
   }

2. Save the generated input to a file (for example, get_key.json) and then edit it to get the specified key.

   {
     "service": {
       "category": "managed-object",
       "resource": "key",
       "action": "get",
       "options": {
         "uuid": "2359E04F-DA61-4F7C-BF9F-913D3369A93A"
       }
     }
   }

3. Run the okv managed-object key get command using the generated JSON file.

   okv managed-object key get --from-json get_key.json

   Output similar to the following appears:

   {
     "result": "Success",
      "value": {
       "object": "E7A641D77DDAF074C62E7A2C2355F2B8D9CD49486E6AF7F38A22CBDEC91630D0"
       }
    }

   If the symmetric key is not extractable, then the following message appears:

   {
    "result" : "Failure",
    "message" : "Operation Result Status: Operation Failed, Result Reason: Unavailable"
   }

Example Using Text as Output Format

okv managed-object certificate-request get --output_format text --uuid 2359E04F-DA61-4F7C-BF9F-913D3369A93A

Output

Output similar to the following appears:

"E7A641D77DDAF074C62E7A2C2355F2B8D9CD49486E6AF7F38A22CBDEC91630D0"
  

Required Authorization

None

Syntax

 okv managed-object key register [--activation-date activation date] [--algorithm algorithm] [--custom-attribute custom attribute]
       [--deactivation-date deactivation date] [--extractable extractable] [--length length] [--mask mask] [--name name] --object object
       [--wallet wallet]

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "key",
    "action" : "register",
    "options" : {
      "length" : "#112,168(3DES)|128,192,256(AES)",
      "object" : "#VALUE",
      "algorithm" : "#3DES|AES",
      "mask" : [ "#ENCRYPT", "#DECRYPT", "#SIGN", "#VERIFY", "#WRAP_KEY", "#UNWRAP_KEY", 
           "#EXPORT", "#DERIVE_KEY", "#GENERATE_CRYPTOGRAM", "#VALIDATE_CRYPTOGRAM", 
           "#TRANSLATE_ENCRYPT", "#TRANSLATE_DECRYPT", "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "extractable" : "#TRUE|FALSE"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

Parameters

Example without using JSON

       okv managed-object key register
        --length 128 --object/Users/dopark/test/my.key --algorithm AES 
        --mask "ENCRYPT" --name dw_0701--activation-date now --deactivation-date "2030-10-10 10:10:10"
        okv managed-object key register --name
        '{"value" : "dw_key_2"}'--activation-date --deactivation-date
        okv managed-object key register --name
        '{"value" : "dw_key_2", "type" :"uri"}' --activation-date --deactivation-date
        okv managed-object key register --name
        '{"value" : "dw_key_2", "type" :"text"}' --activation-date --deactivation-date
        okv managed-object key register --name
        '{"value" : "dw_key_2", "type" :"uri"}' --custom-attribute '[ { "name": "x-OKV
        Private Key UID", "value" :"CA8075A4-C13F-4FD0-BF58-FDB984CC879A"}, { "name":
        "x-NAME2", "value" :"11111"} ] ' --activation-date
        --deactivation-date

JSON Example

1. Generate JSON input for the okv managed-object key register command.

   okv managed-object key register --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "key",
       "action" : "register",
       "options" : {
         "length" : "#112,168(3DES)|128,192,256(AES)",
         "object" : "#VALUE",
         "algorithm" : "#3DES|AES",
         "mask" : [ "#ENCRYPT", "#DECRYPT", "#SIGN", "#VERIFY", "#WRAP_KEY", "#UNWRAP_KEY", 
                    "#EXPORT", "#DERIVE_KEY", "#GENERATE_CRYPTOGRAM", "#VALIDATE_CRYPTOGRAM", 
                    "#TRANSLATE_ENCRYPT", "#TRANSLATE_DECRYPT", "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
         "wallet" : "#VALUE",
         "attributes" : {
           "name" : {
             "value" : "#VALUE",
             "type" : "#text|uri"
           },
           "contactInfo" : "#VALUE",
           "activationDate" : "#YYYY-MM-DD HH:mm:ss",
           "deactivationDate" : "#VALUE",
           "processStartDate" : "#VALUE",
           "protectStopDate" : "#VALUE",
           "extractable" : "#TRUE|FALSE"
         }
       }
     }
   }

2. Save the generated input to a file (for example, reg_key.json) and then edit it to register the key.

   {
     "service": {
       "category": "managed-object",
       "resource": "key",
       "action": "register",
       "options": {
         "length": "256",
         "object": "./object.txt",
         "algorithm": "AES",
         "mask": [
           "ENCRYPT",
           "DECRYPT"
         ],
         "wallet": "hr_wallet",
         "attributes": {
           "name": {
             "value": "FINDB-PROD-MKEY",
             "type": "text"
           },
           "contactInfo" : "pfitch@example.com"
           "activationDate" : "2020-12-31 09:00:00",
           "deactivationDate" : "2024-12-31 09:00:00",
           "processStartDate" : "2020-12-31 09:00:00",
           "protectStopDate" : "2024-12-31 09:00:00",
           "extractable" : "FALSE"
         }
       }
     }
   }

3. Run the okv managed-object key register command using the generated JSON file.

   okv managed-object key register --from-json reg_key.json

   Output similar to the following appears:

   {
    "result": "Success",
     "value": {
      "uuid": "39BE0215-5D7B-4F38-BF5F-FC87C82AA004"
     }
   }

Example Using Text as Output Format

okv managed-object key register --output_format text --algorithm cryptographic_algorithm --length key_length --mask cryptographic_usage_mask --object key_file_path --wallet wallet_name

Output

Output similar to the following appears:

"39BE0215-5D7B-4F38-BF5F-FC87C82AA004"
  

See Oasis Key Management Interoperability Protocol Specification Version 1.1 Oasis Standard for various states that a security object can be in.

Required Authorization

The endpoint must have read-modify permission on the object.

Syntax

okv managed-object object activate --uuid UUID

JSON Input File Template

{
  "service": {
    "category": "managed-object",
    "resource": "object",
    "action": "activate",
    "options": {
      "uuid": "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object managed-object activate command.

   okv managed-object object activate --generate-json-input

   The generated input appears as follows:

   {
     "service": {
       "category": "managed-object",
       "resource": "object",
       "action": "activate",
       "options": {
         "uuid": "#VALUE"
       }
     }
   }

2. Save the generated input to a file (for example, activate_object.json) and then edit it to activate the security object.

   {
     "service": {
       "category": "managed-object",
       "resource": "object",
       "action": "activate",
       "options": {
         "uuid": "2359E04F-DA61-4F7C-BF9F-913D3369A93A"
       }
     }
   }

3. Run the okv managed-object managed-object activate command using the generated JSON file.

   okv managed-object object activate --from-json activate_object.json

   Output similar to the following appears:

   {
    "result": "Success"
   }

Example Using Output Format Text

okv managed-object object activate --output_format text --uuid UUID

Output

Required Authorization

The endpoint must have read-modify permission on the object.

Syntax

okv managed-object object destroy --uuid UUID 

JSON Input File Template

{
  "service": {
    "category": "managed-object",
    "resource": "object",
    "action": "destroy",
    "options": {
      "uuid": "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object object destroy command.

   okv managed-object object destroy --generate-json-input

   The generated input appears as follows:

   {
     "service": {
       "category": "managed-object",
       "resource": "object",
       "action": "destroy",
       "options": {
         "uuid": "#VALUE"
        }
      }
    }

2. Save the generated input to a file (for example, destroy_obj.json) and then edit it so that you can destroy the security object data.

   {
     "service": {
       "category": "managed-object",
       "resource": "object",
       "action": "destroy",
       "options": {
         "uuid": "B36F3AD1-0AC7-4FEB-BF32-79E6F727ECB2"
         }
       }
    }

3. Run the okv managed-object object destroy command using the generated JSON file.

   okv managed-object object destroy --from-json destroy_obj.json

   Output similar to the following appears:

   {
    "result": "Success"
   }

Example Using Output Format Text

okv managed-object object destroy --output_format text --uuid UUID 

Output

Required Authorization

The endpoint must have read permission on the objects.

Syntax

 okv managed-object object locate [--activation-date activation date] [--archive-date archive date] [--certificate-length certificate
       length] [--certificate-type certificate type] [--compromise-date compromise date] [--compromise-occurrence-date compromise occurrence
       date] [--contact-info contact information] [--crypto-usage-mask cryptoUsageMask] [--cryptographic-algorithm cryptographic
       algorithm] [--cryptographic-length cryptographic length] [--custom-attribute custom attribute] [--deactivation-date deactivation date]
       [--destroy-date destroy date] [--digest digest] [--digital-signing-algorithm digital signing algorithm] [--extractable true|false]
       [--initial-date initial date] [--last-change-date last change date] [--link link] [--max max] [--name name] [--never-extractable
       true|false] [--object-group-member object group member] [--object-type object type] [--process-start-date process start date]
       [--protect-stop-date protect stop date] [--single-object true|false] [--state state] [--x509-certificate-issuer X.509 certificate
       issuer] [--x509-certificate-subject X.509 certificate subject]

JSON Input File Template

okv managed-object object locate --generate-json-input

{
  "service" : {
    "category" : "managed-object",
    "resource" : "object",
    "action" : "locate",
    "options" : {
      "max" : "#VALUE",
      "objectGroupMember" : "#FRESH|DEFAULT",
      "attributes" : {
        "name" : {
          "value" : "#VALUE"
        },
        "state" : "#PRE-ACTIVE|ACTIVE|DEACTIVATED|COMPROMISED|DESTROYED|DESTROYED_COMPROMISED",
        "objectType" : "#VALUE",
        "fresh" : "#YES|NO",
        "objectGroup" : "#VALUE",
        "contactInfo" : "#VALUE",
        "cryptographicAlgorithm" : "#VALUE",
        "cryptographicLength" : "#VALUE",
        "cryptoUsageMask" : "#VALUE",
        "certificateLength" : "#VALUE",
        "certificateType" : "#VALUE",
        "x509CertificateSubject" : "#VALUE",
        "x509CertificateIssuer" : "#VALUE",
        "digitalSigningAlgorithm" : "#VALUE",
        "digest" : {
          "digestValue" : "#VALUE",
          "algorithm" : "#VALUE",
          "keyFormatType" : "#VALUE"
        },
        "link" : {
          "linkType" : "#VALUE",
          "linkValue" : "#VALUE"
        },
        "activationDate" : "#YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#YYYY-MM-DD HH:mm:ss",
        "initialDate" : "#YYYY-MM-DD HH:mm:ss",
        "lastChangeDate" : "#YYYY-MM-DD HH:mm:ss",
        "compromiseDate" : "#YYYY-MM-DD HH:mm:ss",
        "compromiseOccurrenceDate" : "#YYYY-MM-DD HH:mm:ss",
        "destroyDate" : "#YYYY-MM-DD HH:mm:ss",
        "archiveDate" : "#YYYY-MM-DD HH:mm:ss",
        "extractable" : "#TRUE|FALSE",
        "neverExtractable" : "#TRUE|FALSE"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object object locate command.

   okv managed-object object locate --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "object",
       "action" : "locate",
       "options" : {
         "max" : "#VALUE",
         "objectGroupMember" : "#FRESH|DEFAULT",
         "attributes" : {
           "name" : {
             "value" : "#VALUE"
           },
           "state" : "#PRE-ACTIVE|ACTIVE|DEACTIVATED|COMPROMISED|DESTROYED|DESTROYED_COMPROMISED",
           "objectType" : "#VALUE",
           "fresh" : "#YES|NO",
           "objectGroup" : "#VALUE",
           "contactInfo" : "#VALUE",
           "cryptographicAlgorithm" : "#VALUE",
           "cryptographicLength" : "#VALUE",
           "cryptoUsageMask" : "#VALUE",
           "certificateLength" : "#VALUE",
           "certificateType" : "#VALUE",
           "x509CertificateSubject" : "#VALUE",
           "x509CertificateIssuer" : "#VALUE",
           "digitalSigningAlgorithm" : "#VALUE",
           "digest" : {
             "digestValue" : "#VALUE",
             "algorithm" : "#VALUE",
             "keyFormatType" : "#VALUE"
           },
           "link" : {
             "linkType" : "#VALUE",
             "linkValue" : "#VALUE"
           },
           "activationDate" : "#YYYY-MM-DD HH:mm:ss",
           "deactivationDate" : "#YYYY-MM-DD HH:mm:ss",
           "processStartDate" : "#YYYY-MM-DD HH:mm:ss",
           "protectStopDate" : "#YYYY-MM-DD HH:mm:ss",
           "initialDate" : "#YYYY-MM-DD HH:mm:ss",
           "lastChangeDate" : "#YYYY-MM-DD HH:mm:ss",
           "compromiseDate" : "#YYYY-MM-DD HH:mm:ss",
           "compromiseOccurrenceDate" : "#YYYY-MM-DD HH:mm:ss",
           "destroyDate" : "#YYYY-MM-DD HH:mm:ss",
           "archiveDate" : "#YYYY-MM-DD HH:mm:ss",
           "extractable" : "#TRUE|FALSE",
           "neverExtractable" : "#TRUE|FALSE"
         },
         "customAttributes" : [ {
           "name" : "#VALUE",
           "value" : "#VALUE",
           "type" : "#TEXT|NUMBER"
         } ]
       }
     }
   }

2. Save the generated input to a file (for example, locate_obj.json) and then edit it to locate the security object.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "object",
       "action" : "locate",
       "options" : {
         "max" : "10",
         "objectGroupMember" : "FRESH",
         "attributes" : {
            "state": "ACTIVE",
             "name": {
               "value": "key8"
            },
            "fresh" : "Yes",
            "activationDate": "2021-04-10 07:16:00",
             "link" : {
               "linkType" : "Replaced Object Link",
               "linkValue" : "6B13B7B3-BE61-4FF6-BFB0-4108231392F8"
              },
             "extractable" : "FALSE",
             "neverExtractable" : "TRUE"
         },
        "customAttributes" : [{
           "name": "x-test_1",
           "value": "test_1",
           "type": "TEXT"
          },
          {
           "name": "x-number",
           "value": "1",
           "type": "NUMBER"
          }]
       }
     }
   }

3. Run the okv managed-object object locate command using the generated JSON file.

   okv managed-object object locate --from-json locate_obj.json

   Output similar to the following appears:

   {
        "result" : "Success",
        "value" : {
          "uuids" : [ "6C51CC04-BFA5-4FBD-BFB4-12DCCECAA355" ]
     }
    }

Example Using Output Format Text

okv managed-object object locate --output_format text|json --output_format text --max max_value --object-group-member object_group_member_type --state state_value --name name_value --custom-attribute custom_attributes_value

Output

Output similar to the following appears:

"6C51CC04-BFA5-4FBD-BFB4-12DCCECAA355"
  

Required Authorization

None

Syntax

okv managed-object object query

JSON Input File Template

{
  "service": {
    "category": "managed-object",
    "resource": "object",
    "action": "query"
  }
}

Parameters

None

JSON Example

1. Generate JSON input for the okv managed-object object query command.

   okv managed-object object query --generate-json-input

   The generated input appears as follows:

   {
     "service": {
       "category": "managed-object",
       "resource": "object",
       "action": "query"
     }
   }

2. Save the generated input to a file (for example, query_obj.json).
3. Run the okv managed-object object query command using the generated JSON file.

   okv managed-object object query --from-json query_obj.json

   Output similar to the following appears:

   {
     "result": "Success",
     "value": {
       "objects": [
         "Symmetric Key",
         "Template",
         "Secret Data",
         "Opaque Object",
         "Certificate"
       ],
       "operations": [
         "Create",
         "Register",
         "Re-key",
         "Locate",
         "Check",
         "Get",
         "Get Attributes",
         "Get Attribute List",
         "Add Attribute",
         "Modify Attribute",
         "Delete Attribute",
         "Activate",
         "Revoke",
         "Destroy",
         "Query",
         "Discover Versions"
       ]
     }
   }

Required Authorization

The endpoint must have read-modify permission on the object.

Syntax

okv managed-object object revoke --code code --reason reason --compromise-occurrence-date date --uuid UUID 

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "object",
    "action" : "revoke",
    "options" : {
      "code" : "#UNSPECIFIED|KEY_COMPROMISE|CA_COMPROMISE|AFFILIATION_CHANGED|SUPERSEDED|CESSATION_OF_OPERATION|PRIVILEGE_WITHDRAWN",
      "reason" : "#VALUE",
      "compromiseOccurrenceDate" : "#YYYY-MM-DD HH:mm:ss",
      "uuid" : "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object object revoke command.

   okv managed-object object revoke --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "object",
       "action" : "revoke",
       "options" : {
         "code" : "#UNSPECIFIED|KEY_COMPROMISE|CA_COMPROMISE|AFFILIATION_CHANGED|SUPERSEDED|CESSATION_OF_OPERATION|PRIVILEGE_WITHDRAWN",
         "reason" : "#VALUE",
         "compromiseOccurrenceDate" : "#YYYY-MM-DD HH:mm:ss",
         "uuid" : "#VALUE"
       }
     }
   }

2. Save the generated input to a file (for example, revoke_obj.json) and then edit it so that you can revoke the security object privileges.

   {
     "service": {
       "category": "managed-object",
       "resource": "object",
       "action": "revoke",
       "options": {
         "code": "KEY_COMPROMISE",
         "reason": "security incidence",
         "compromiseOccurrenceDate": "2020-11-20 10:34:29",
         "uuid": "E4CA6A16-B3CD-4F98-BF25-4A0EF482B8B8"
       }
     }
   }

3. Run the okv managed-object object revoke command using the generated JSON file.

   okv managed-object object revoke --from-json revoke_obj.json

   Output similar to the following appears:

   {
    "result": "Success"
   }

Example Using Output Format Text

okv managed-object object revoke --output_format text --code code --reason reason --compromise-occurrence-date date --uuid UUID 

Output

Required Authorization

The endpoint must have read permission on the object.

Syntax

okv managed-object opaque get ----output_format <text|json> --uuid UUID

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "opaque",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object opaque get command.

   okv managed-object opaque get --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "opaque",
       "action" : "get",
       "options" : {
         "uuid" : "#VALUE"
       }
     }
   }

2. Save the generated input to a file (for example, get_opaque_object.json) and then edit it to retrieve the data from the opaque object.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "opaque",
       "action" : "get",
       "options" : {
         "uuid" : "2359E04F-DA61-4F7C-BF9F-913D3369A93A"
       }
     }
   }

3. Run the okv managed-object opaque get command using the generated JSON file.

   okv managed-object opaque get --from-json get_opaque_object.json

   Output similar to the following appears:

   {
     "result" : "Success",
     "value" : {
      "object" : "2D2D2D2D2D424547494E2050524956415445204B45592D2D2D2D2D0A4D494945765149424144414E42676B71686B6947397730424151454641415343424B637767675363
       <<<< Output Truncated>>>>
       7067533170633634656D3630686C72336B786C593858665734317A594A450A724546334C652F4A4F4B4968674A754C367352734C67553D0A2D2D2D2D2D454E442050524956415445204B45592D2D2D2D2D0A"
      }
    }

Example Using Output Format Text

okv managed-object opaque get --output_format text --uuid 2359E04F-DA61-4F7C-BF9F-913D3369A93A

Output

Output similar to the following appears:

2D2D2D2D2D424547494E2050524956415445204B45592D2D2D2D2D0A4D494945765149424144414E42676B71686B6947397730424151454641415343424B637767675363
<<<< Output Truncated>>>>
7067533170633634656D3630686C72336B786C593858665734317A594A450A724546334C652F4A4F4B4968674A754C367352734C67553D0A2D2D2D2D2D454E442050524956415445204B45592D2D2D2D2D0A
  

Objects containing opaque data are not necessarily interpreted by the server.

Required Authorization

None

Syntax

okv managed-object opaque register [--custom-attribute custom attribute] [--name name] --object object
 [--wallet wallet]

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "opaque",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object opaque register command.

   okv managed-object opaque register --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "opaque",
       "action" : "register",
       "options" : {
         "object" : "#VALUE",
         "wallet" : "#VALUE",
         "attributes" : {
           "name" : {
             "value" : "#VALUE",
             "type" : "#text|uri"
           },
           "contactInfo" : "#VALUE",
           "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
         },
         "customAttributes" : [ {
           "name" : "#VALUE",
           "value" : "#VALUE",
           "type" : "#TEXT|NUMBER"
         } ]
       }
     }
   }

2. Save the generated input to a file (for example, reg_opaque.json) and then edit it to register the opaque key.

   {
     "service": {
       "category": "managed-object",
       "resource": "opaque",
       "action": "register",
       "options": {
         "object": "./key.pem",
         "wallet": "hr_wallet",
         "attributes": {
           "name": {
             "value": "Opaque-Key-102",
             "type": "text"
           },
           "contactInfo" : "psmith@example.com"
           "activationDate" : "2020-12-31 09:00:00",
           "deactivationDate" : "2024-12-31 09:00:00",
           "processStartDate" : "2020-12-31 09:00:00",
           "protectStopDate" : "2024-12-31 09:00:00"
         }
       }
     }
   }

3. Run the okv managed-object opaque register command using the generated JSON file.

   okv managed-object opaque register --from-json reg_opaque.json

   Output similar to the following appears:

   {
    "result" : "Success",
     "value" : {
      "uuid" : "B44A99FD-F892-4F3E-BF7D-487B68159CC3"
     }
   }

Example Using Output Format Text

okv managed-object opaque register --output_format text --object object_name --wallet wallet_name

Output

Output similar to the following appears:

"B44A99FD-F892-4F3E-BF7D-487B68159CC3"
  

Required Authorization

The endpoint must have read permission on the private key.

Syntax

okv managed-object private-key get  --output_format text|json --uuid UUID

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "private-key",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object private-key get command.

   okv managed-object private-key get  --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "private-key",
       "action" : "get",
       "options" : {
         "uuid" : "#VALUE"
       }
     }
   }

2. Save the generated input to a file (for example, get_private_key.json) and then edit it to specify the UUID of the private key.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "private-key",
       "action" : "get",
       "options" : {
         "uuid" : "2F9E2A31-D15A-4F5B-BFA0-761892021DBE"
       }
     }
   }

3. Run the okv managed-object private-key get command using the generated JSON file.

   okv managed-object private-key get  --from-json get_private_key.json

   Output similar to the following appears:

   {
        "result" : "Success",
        "value" : {
          "object" : "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAg << output truncated >> /onTXJKf8A1kZwPW/Qa6IpPOGCfOJDtyM9F5X9REaJQr+1\nXw1sBm1Tjh4z/m6rsKK6A4YP\n-----END PRIVATE KEY-----"
                  }
   } 
   

Example Using Output Format Text

okv managed-object private-key get --output_format text --uuid 2F9E2A31-D15A-4F5B-BFA0-761892021DBE

Output

Output similar to the following appears:

"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAg << output truncated >> /onTXJKf8A1kZwPW/Qa6IpPOGCfOJDtyM9F5X9REaJQr+1\nXw1sBm1Tjh4z/m6rsKK6A4YP\n-----END PRIVATE KEY-----"
  

Required Authorization

None

Syntax

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "private-key",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "algorithm" : "#RSA",
      "length" : "#1024,2048,4096(RSA)",
      "sshUser" : "#VALUE"
      "mask" : [ "#SIGN", "#ENCRYPT", "#DECRYPT", "#WRAP_KEY", "#UNWRAP_KEY", 
                 "#EXPORT", "#DERIVE_KEY", "#TRANSLATE_ENCRYPT", "#TRANSLATE_DECRYPT",
                 "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "extractable" : "#TRUE|FALSE"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}
    

Parameters

Example without using JSON

         okv managed-object private-key register --algorithm RSA --length 2048
         --mask"ENCRYPT" --object /Users/dopark/test/id_rsa 
         --name private_0701--activation-date now --deactivation-date "2030-10-10 10:10:10"

JSON Example

1. Generate JSON input for the okv managed-object private-key register command.

   okv managed-object private-key register --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "private-key",
       "action" : "register",
       "options" : {
         "object" : "#VALUE",
         "algorithm" : "#RSA",
         "length" : "#1024,2048,4096(RSA)",
         
         "mask" : [ "#SIGN", "#ENCRYPT", "#DECRYPT", "#WRAP_KEY", "#UNWRAP_KEY",
                    "#EXPORT", "#DERIVE_KEY", "#TRANSLATE_ENCRYPT", "#TRANSLATE_DECRYPT", 
                    "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
         "wallet" : "#VALUE",
         "attributes" : {
           "name" : {
             "value" : "#VALUE",
             "type" : "#text|uri"
           },
           "contactInfo" : "#VALUE",
           "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "extractable" : "#TRUE|FALSE"
         },
         "customAttributes" : [ {
           "name" : "#VALUE",
           "value" : "#VALUE",
           "type" : "#TEXT|NUMBER"
         } ]
       }
     }
   }
         }
       }
     }
   }

2. Save the generated input to a file (for example, reg_private_key.json) and then edit it to specify the appropriate private key settings.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "private-key",
       "action" : "register",
       "options" : {
         "object" : "./priv_key.pem",
         "algorithm" : "RSA",
         "length" : "2048",
         "mask" : [ "ENCRYPT", "DECRYPT" ],
         "wallet" : "hr_wallet",
         "attributes" : {
           "name" : {
             "value" : "CERT-APPID-103",
             "type" : "text"
           },
           "contactInfo" : "psmith@example.com"
           "activationDate" : "2020-12-31 09:00:00",
           "deactivationDate" : "2024-12-31 09:00:00",
           "processStartDate" : "2020-12-31 09:00:00",
           "protectStopDate" : "2024-12-31 09:00:00"
         }
       }
     }
   }

3. Run the okv managed-object private-key register command using the generated JSON file.

   okv managed-object private-key register --from-json reg_private_key.json

   Output similar to the following appears:

   {
     "result" : "Success",
      "value" : {
       "uuid" : "2F9E2A31-D15A-4F5B-BFA0-761892021DBE"
     }
   }

Example Using Output Format Text

okv managed-object private-key register --output_format text --object private_key_file_path --algorithm cryptographic_algorithm --length key_length --mask cryptographic_usage_mask --wallet wallet_name

Output

Output similar to the following appears:

"2F9E2A31-D15A-4F5B-BFA0-761892021DBE"
  

Required Authorization

The endpoint must have read permission on the public key.

Syntax

okv managed-object public-key get  --output_format text|json --uuid UUID

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "public-key",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object public-key get command.

   okv managed-object public-key get --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "public-key",
       "action" : "get",
       "options" : {
         "uuid" : "#VALUE"
       }
     }
   }

2. Save the generated input to a file (for example, get_public_key.json) and then edit it to specify the UUID of the public key.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "public-key",
       "action" : "get",
       "options" : {
         "uuid" : "11652909-D019-4F3B-BFB9-791723095005"
       }
     }
   }

3. Run the okv managed-object public-key get command using the generated JSON file.

   okv managed-object public-key get  --from-json get_public_key.json

   Output similar to the following appears:

   {
     "result" : "Success",
     "value" : {
       "object" : "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtK4YrT6A/4tVnadRg0ZT\nprsdUwXrIdoqf1+ye/yVkN6RmtR7mthn6WIIrbTVX5MuAkLc6yyuMEc+nLDPZzrU\nFXkCAQeVR7sT/hQo74dQHebIfJxgx+uZrlzOgT4Il1qfmjR6y81RjTvAU8ZPdzPb\nuXKHZErZVQdoXUw5uFrTNzOegLbYJFI2dZnf3erB7Ho64DckFRoFP05cc3A0iLrL\ntzE8CcjAlBlXTGJD4kAtTEet/0TkvuHzBHr23zkfj0kWV3PHGYYC3O+/UzXg/nal\n3iTK5yRDkln45AyI/PkfzAFiZ/kX9C66H0WRMxgfaOn/uRNbikFOFK6IPOGcT+0S\n/QIDAQAB\n-----END PUBLIC KEY-----"
      }
    }

Example Using Output Format Text

okv managed-object public-key get --output_format text --uuid 11652909-D019-4F3B-BFB9-791723095005

Output

Output similar to the following appears:

"-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtK4YrT6A/4tVnadRg0ZT\nprsdUwXrIdoqf1+ye/yVkN6RmtR7mthn6WIIrbTVX5MuAkLc6yyuMEc+nLDPZzrU\nFXkCAQeVR7sT/hQo74dQHebIfJxgx+uZrlzOgT4Il1qfmjR6y81RjTvAU8ZPdzPb\nuXKHZErZVQdoXUw5uFrTNzOegLbYJFI2dZnf3erB7Ho64DckFRoFP05cc3A0iLrL\ntzE8CcjAlBlXTGJD4kAtTEet/0TkvuHzBHr23zkfj0kWV3PHGYYC3O+/UzXg/nal\n3iTK5yRDkln45AyI/PkfzAFiZ/kX9C66H0WRMxgfaOn/uRNbikFOFK6IPOGcT+0S\n/QIDAQAB\n-----END PUBLIC KEY-----"
  

Required Authorization

None

Syntax

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "public-key",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "algorithm" : "#RSA",
      "length" : "#1024,2048,3072,4096(RSA)",
      "sshUser" : "#VALUE",
      "mask" : [ "#VERIFY", "#ENCRYPT", "#DECRYPT","#WRAP_KEY", "#UNWRAP_KEY",
                 "#EXPORT", "#DERIVE_KEY", "#TRANSLATE_ENCRYPT", 
                 "#TRANSLATE_DECRYPT", "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
      "privateKeyUUID" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object public-key register command.

   okv managed-object public-key register --generate-json-input

   The generated input appears as follows:

    {
     "service" : {
       "category" : "managed-object",
       "resource" : "public-key",
       "action" : "register",
       "options" : {
         "object" : "#VALUE",
         "algorithm" : "#RSA",
         "length" : "#1024,2048,3072,4096(RSA)",
         "sshUser" : "#VALUE",
         
         "mask" : [ "#VERIFY", "#ENCRYPT", "#DECRYPT", "#WRAP_KEY","#UNWRAP_KEY",
                    "#EXPORT", "#DERIVE_KEY", "#TRANSLATE_ENCRYPT", 
                    "#TRANSLATE_DECRYPT", "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
         "privateKeyUUID" : "#VALUE",
         "wallet" : "#VALUE",
         "attributes" : {
           "name" : {
             "value" : "#VALUE",
             "type" : "#text|uri"
           },
           "contactInfo" : "#VALUE",
           "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
         },
         "customAttributes" : [ {
           "name" : "#VALUE",
           "value" : "#VALUE",
           "type" : "#TEXT|NUMBER"
         } ]
       }
     }
   }

2. Save the generated input to a file (for example, reg_public_key.json) and then edit it to specify the appropriate public key settings.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "public-key",
       "action" : "register",
       "options" : {
         "object" : "./key.pub",
         "algorithm" : "RSA",
         "length" : "2048",
         "mask" : [ "ENCRYPT", "DECRYPT" ],
         "privateKeyUUID" : "2F9E2A31-D15A-4F5B-BFA0-761892021DBE ",
         "wallet" : "hr_wallet",
         "attributes" : {
           "name" : {
             "value" : " FINDB-PROD-PUBKEY ",
             "type" : "text"
           },
           "contactInfo" : "psmith@example.com"
           "activationDate" : "2020-12-31 09:00:00",
           "deactivationDate" : "2024-12-31 09:00:00",
           "processStartDate" : "2020-12-31 09:00:00",
           "protectStopDate" : "2024-12-31 09:00:00"
         }
       }
     }
   }

3. Run the okv managed-object public-key register command using the generated JSON file.

   okv managed-object public-key register --from-json reg_public_key.json

   Output similar to the following appears:

   {
     "result" : "Success",
      "value" : {
       "uuid" : "11652909-D019-4F3B-BFB9-791723095005"
      }
    }

Example without using JSON

okv managed-object public-key register   --object
id_rsa.pub  --algorithm RSA ---length 2048 -mask "ENCRYPT"
--private-key-uuid  95092BD2-B546-4F9A-BF0B-D8ECDC548546 --name hr_public_key
--activation-date now --deactivation-date "2030-10-10 10:10:10

Example Using Output Format Text

okv managed-object public-key register --output_format text --object public_key_file_path --algorithm cryptographic_algorithm --length key_length --mask cryptographic_usage_mask --private-key-uuid private_key_uuid --wallet wallet_nameokv managed-object public-key get --output_format text --uuid UUID

Output

Output similar to the following appears:

"11652909-D019-4F3B-BFB9-791723095005 "
  

Required Authorization

The endpoint must have read permission on the secret object.

Syntax

okv managed-object secret get --output_format text|json --uuid UUID

JSON Input File Template

{
  "service": {
    "category": "managed-object",
    "resource": "secret",
    "action": "get",
    "options": {
      "uuid": "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object secret get command.

   okv managed-object secret get --generate-json-input

   The generated input appears as follows:

   {
     "service": {
       "category": "managed-object",
       "resource": "secret",
       "action": "get",
       "options": {
         "uuid": "#VALUE"
       }
     }
   }

2. Save the generated input to a file (for example, secret_get.json) and then edit it to locate the secret object.

   {
     "service": {
       "category": "managed-object",
       "resource": "secret",
       "action": "get",
       "options": {
         "uuid": "D69D2F32-2DBB-4FF3-BF52-95487526E6EC"
       }
     }
   }

3. Run the okv managed-object secret get command using the generated JSON file.

   okv managed-object secret get --from-json secret_get.json

   Output similar to the following appears:

   {
        "result": "Success",
        "value": {
          "object": "ki3j&8slo73y2ls"
         }
      }

Example Using Output Format Text

okv managed-object secret get --output_format text --uuid D69D2F32-2DBB-4FF3-BF52-95487526E6EC

Output

Output similar to the following appears:

"ki3j&8slo73y2ls"
  

Required Authorization

None

Syntax

okv managed-object secret register [--activation-date activation date] [--custom-attribute custom attribute] 
[--deactivation-date deactivation date] [--mask mask] [--name name] --object object [--type type] [--wallet wallet]

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "secret",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "type" : "#PASSWORD|SEED",
      
      "mask" : [ "#DERIVE_KEY", "#EXPORT" ],
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

Parameters

Example without using JSON

okv managed-object secret register --type PASSWORD --mask "DERIVE_KEY"
--name secret_0701 --object /Users/dopark/test/my.secret --activation-date now
--deactivation-date "2030-10-10 10:10:10

JSON Example

1. Generate JSON input for the okv managed-object secret register command.

   okv managed-object secret register --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "secret",
       "action" : "register",
       "options" : {
         "object" : "#VALUE",
         "type" : "#PASSWORD|SEED",
         "mask" : [ "#DERIVE_KEY", "#EXPORT" ],
        
         "wallet" : "#VALUE",
         "attributes" : {
           "name" : {
             "value" : "#VALUE",
             "type" : "#text|uri"
           },
           "contactInfo" : "#VALUE",
           "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
           "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
         },
         "customAttributes" : [ {
           "name" : "#VALUE",
           "value" : "#VALUE",
           "type" : "#TEXT|NUMBER"
         } ]
       }
     }
   }

2. Save the generated input to a file (for example, reg_secret.json) and then edit it to register the secret object.

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "secret",
       "action" : "register",
       "options" : {
         "object" : "./hr_db_connect_password.txt",
         "type" : "PASSWORD",
         "mask" : [ "DERIVE_KEY" ],
         "wallet" : "hr_wallet",
         "attributes" : {
           "name" : {
             "value" : "HR-DB-CONNECT-PASSWORD",
             "type" : "text"
           },
           "contactInfo" : "psmith@example.com"
           "activationDate" : "2020-12-31 09:00:00",
           "deactivationDate" : "2024-12-31 09:00:00",
           "processStartDate" : "2020-12-31 09:00:00",
           "protectStopDate" : "2024-12-31 09:00:00"
         }
       }
     }
   }

3. Run the okv managed-object secret register command using the generated JSON file.

   okv managed-object secret register --from-json reg_secret.json

   Output similar to the following appears:

   {
        "result": "Success",
        "value": {
         "uuid": "0F54D31A-ABA0-4F15-BF67-1B7513DD8634"
         }
   }

Example Using Output Format Text

okv managed-object secret register --output_format text --object object_name type PASSWORD|SEED 
wallet wallet_name --mask cryptogrpahic_usage_mask

Output

Output similar to the following appears:

"0F54D31A-ABA0-4F15-BF67-1B7513DD8634"
  

This command authenticates with the endpoint's client certificate.

Required Authorization

The endpoint must have read-modify permission on the object and manage-wallet access (MW) on the wallet.

Syntax

okv managed-object wallet add-member -output_format text|json --uuid UUID --wallet wallet_name 

JSON Input File Template

{
  "service": {
    "category": "managed-object",
    "resource": "wallet",
    "action": "add-member",
    "options": {
      "uuid": "#VALUE",
      "wallet": "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object wallet add-member command.

   okv managed-object wallet add-member --generate-json-input

   The generated input appears as follows:

   {
     "service": {
       "category": "managed-object",
       "resource": "wallet",
       "action": "add-member",
       "options": {
         "uuid": "#VALUE",
         "wallet": "#VALUE"
       }
     }
   }

2. Save the generated input to a file (for example, add_wallet_member.json) and then edit it to add the security object to the wallet.

   {
     "service": {
       "category": "managed-object",
       "resource": "wallet",
       "action": "add-member",
       "options": {
         "uuid": "D69D2F32-2DBB-4FF3-BF52-95487526E6EC",
         "wallet": "hr_wallet"
       }
     }
   }

3. Run the okv managed-object wallet add-member command using the generated JSON file.

   okv managed-object wallet add-member --from-json add_wallet_member.json

   Output similar to the following appears:

   {
    "result": "Success"
   }

Example Using Output Format Text

okv managed-object wallet add-member --output_format text --uuid UUID --wallet wallet_name 

Output

This command authenticates with the endpoint's client certificate.

Required Authorization

The endpoint must have read-modify permission on the object and manage-wallet access (MW) on the wallet.

Syntax

okv managed-object wallet delete-member -output_format text|json--uuid UUID --wallet wallet_name 

JSON Input File Template

{
  "service": {
    "category": "managed-object",
    "resource": "wallet",
    "action": "delete-member",
    "options": {
      "uuid": "#VALUE",
      "wallet": "#VALUE"
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object wallet delete-member command.

   okv managed-object wallet delete-member --generate-json-input

   The generated input appears as follows:

   {
     "service": {
       "category": "managed-object",
       "resource": "wallet",
       "action": "delete-member",
       "options": {
         "uuid": "#VALUE",
         "wallet": "#VALUE"
       }
     }
   }

2. Save the generated input to a file (for example, delete_wallet_member.json) and then edit it to delete the security object from the wallet.

   {
     "service": {
       "category": "managed-object",
       "resource": "wallet",
       "action": "delete-member",
       "options": {
         "uuid": "D69D2F32-2DBB-4FF3-BF52-95487526E6EC",
         "wallet": "hr_wallet"
       }
     }
   }

3. Run the okv managed-object wallet delete-member command using the generated JSON file.

   okv managed-object wallet delete-member --from-json delete_wallet_member.json

   Output similar to the following appears:

   {
    "result": "Success"
   }

Example Using Output Format Text

okv managed-object wallet delete-member --output_format text --uuid UUID --wallet wallet_name 

Output

This command authenticates with the endpoint's client certificate.

Required Authorization

None, but this command returns only those wallets to which the current endpoint is granted access.

Syntax

okv managed-object wallet list

JSON Input File Template

{
  "service" : {
    "category" : "managed-object",
    "resource" : "wallet",
    "action" : "list"
     }
}

Parameters

JSON Example

1. Generate JSON input for the okv managed-object wallet list command.

   okv managed-object wallet list --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "managed-object",
       "resource" : "wallet",
       "action" : "list"
        }
   }

2. Save the generated input to a file (for example, wallet_list.json).
3. Run the okv managed-object wallet list command using the generated JSON file.

   okv managed-object wallet list --from-json wallet_list.json

   Output similar to the following appears:

   {
     "result": "Success",
     "value": {
       "wallets": {
         "HR_WALLET",
         "SALES_WALLET"
         }
      }
    )
    

Example Using Output Format Text

okv managed-object wallet list -output_format text

Output

Output similar to the following appears:

"HR_WALLET","SALES_WALLET