POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/smk/{smkid}/actions/{actionid}

Performs the action on the SMK Key.

Note Action start and end is only supported by key smk-fw7-rollover.

User Privileges

Users with the following role privileges can perform this command:

admin
operator

Parameters

hsmid

The serial number of the HSM of interest.

Use: Required

JSON Schema:

   Object
   type: integer
   format: int64
   minimum: 1
   maximum: 9999999999

partitionid

The identifier of the partition of interest

Use: Required

JSON Schema:

   Object
   type: integer
   format: int64
   minimum: 1000000
   maximum: 99999999999999999

smkid

The identifier of the smk of interest

Use: Required

JSON Schema:

   Object
   type: string
   minLength: 1
   maxLength: 32
   pattern: ^[a-zA-Z0-9_.-]*$

actionid

The identifier of the action to be performed.

Use: Required

JSON Schema:

   Object
   type: string
   minLength: 1
   maxLength: 32
   pattern: ^[a-zA-Z0-9_.-]*$

Responses

200

JSON Schema: SMK Key

400

FRAMEWORK_BAD_REQUEST

Returned when the input data does not conform to the required validation schema.

HSMPLUGIN_PARTITION_VERSION_INVALID

HSMPLUGIN_FUNC_NOT_SUPPORTED

Partition or Firmware does not support SMK.

401

HSMPLUGIN_PARTITION_USER_NOT_AUTHENTICATED

Partition user is not authenticated.

403

HSMPLUGIN_SMK_ROLLOVER_IN_PROGRESS

SMK Rollover is in-progress. End it before starting again.

409

HSMPLUGIN_SMK_NOT_INITIALIZED

FW7-Primary must be in 'initialized' state before performing this action.

404

HSMPLUGIN_INVALID_HSM

HSMPLUGIN_INVALID_PARTITION

HSMPLUGIN_INVALID_SMKID

HSMPLUGIN_INVALID_ACTION

HSM or Partition or SMK or Action key does not exist.

422

HSMPLUGIN_OPERATION_NOT_ALLOWED

Requested action is only permitted for 'FW7-Rollover'.

Example Request

   POST
   https://1.2.3.4:8443/api/lunasa/hsms/123456/partitions/1234567891012/smk/smk-fw7-rollover/actions/start

Example Result

{
}