PATCH /api/lunasa/hsms/{hsmid}/roles/{roleid}

PATCH /api/lunasa/hsms/{hsmid}/roles/{roleid}

Changes the password for an HSM role.

This resource is forbidden on the HSM.

Parameters

hsmid

The serial number of the HSM of interest

Use: Required

JSON Schema:

   Object
   type: string

roleid

The identifier of the role of interest

Use: Required

JSON Schema:

   Object
   type: string

oldPassword

The existing password for the role

Use: Required

JSON Schema:

   Object
   type: string

newPassword

The desired password for the role

Use: Required

JSON Schema:

   Object
   type: string

changeSecret

(Optional) Change the secret for a PED-authenticated HSM. This parameter applies for the CO (Admin User) role.

Use: Required

JSON Schema:

   Object
   type: boolean

Responses

204

Success

Location

"Location" is the URL to the role and is returned in the server response. You can use "Location" to form a GET resource to query the role.

see GET /api/lunasa/hsms/{hsmid}/roles/{roleid}


For PED-based partitions, "Location" is the URL to the task spawned to change the password for the HSM role.

400

Unexpected error

404

HSM or role does not exist.

Example Request

   PATCH
   https://1.2.3.4:8443/api/lunasa/hsms/154704/roles/co
   { "newPassword": "Aaaa1234",
     "oldPassword": "myPassword" }

Example Result

{
password-based HSM:
{'Access-Control-Allow-Origin': '*', 'Content-Type': 'application/json', 'Location': '/api/lunasa/hsms/154704/roles/cu', 'Content-Length': '2', 'Access-Control-Allow-Credentials': 'true'}

PED-based HSM:
{'Access-Control-Allow-Origin': '*', 'Content-Type': 'application/json', 'Location': '/tasks/9', 'Content-Length': '712', 'Access-Control-Allow-Credentials': 'true'}
}