REST API  4.0.0
REST API for SafeNet Network HSMs
POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/stc/clients

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/stc/clients

Registers a client identity for secure trusted communication with a partition.

Parameters

hsmid

The serial number of the HSM of interest

Use: Required

JSON Schema:

   Object
   type: string

partitionid

The identifier of the partition of interest

Use: Required

JSON Schema:

   Object
   type: string

identity

The client identity, a base64-encoded version of the client identity file created by lunacm

Use: Required

JSON Schema:

   Object
   type: string

label

The user-friendly name to refer to the client identity

Use: Required

JSON Schema:

   Object
   type: string

Responses

204

The client identity registered.

JSON Schema:

    type:  string
    description:  client is the identifier for identity now registered with the partition.

Location

JSON Schema:

    id: Object
        type: string

"Location" is the URL to the client identity and is returned in the server response. You can use "Location" to form a GET resource to obtain the client identity.


see GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/stc/clients/{clientid}

400

Unexpected error

404

HSM or partition does not exist.

Example Request

   POST 
   https://1.2.3.4:8443/api/lunasa/hsms/154704/partitions/273087011507/stc/clients
   {
   "identity": "U2FmZU5ldFN0Y0NsaWVudElkZW50aXR5UHViAAAAAAABLS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFuM1dHL1RkVjRMcGZxYXd0M0ZNTwpVVTJEMm93ZjcxRjZ5Yk5TanE2SFdFbXVWSEtvMlZiM05mWGxEYzc4UTk1Mm1odm5ac1MzV1dPL0xNWnlqVFU1CjltSWtnblBvdWZ6NFM5UEFQSzRxdXdTMURjekFMaElnQ09hMXcrMVhpMm9yM1hFa044cHpxWng4MG9zcC9kT0gKem0yc3NZVnQ5V3pLb2FtY0pGdjJNWEc5Q0ErcUZlbVdSRjFsZVdqQ0RLUXErbDUyM0VvMzVoMXhzUENhd0xHSAp2NFFNTkIrSXZvUG1KUHVnem9iTnVOSUd2MGtCUFJ5ajJobi9qdU5HZ0svbzNiS01aOGYycEs3cjg1dHh0bVhBClk1dUp0alRhU2ZmRm9SZTJ3bDBIQ1gxTlM2dklPZ2xTUkRoQ1FZVTZ3YVIwL05YeWFSOWdLQTc3bDFrREQ0c3QKclFJREFRQUIKLS0tLS1FTkQgUFVCTElDIEtFWS0tLS0tCg==",
   "label": "client3"
   }

Example Result

{'Access-Control-Allow-Origin': '*', 'Content-Type': 'application/json', 'Location': '/api/lunasa/hsms/154704/partitions/273087011507/stc/clients/3', 'Content-Length': '2', 'Access-Control-Allow-Credentials': 'true'}

{
    "client": "3"
}