REST API  17
REST API for Luna Network HSMs
PUT /api/lunasa/ntls/clients/{clientid}/dn

PUT /api/lunasa/ntls/clients/{clientid}/dn

This resource assigns a distinguished name filter to a client.

User Privileges

Users with the following role privileges can perform this command:

  • admin
  • operator

Parameters

clientid

The identifier of the client of interest.

Use: Required

JSON Schema:

   Object
   type: string
   minLength: 1
   maxLength: 128
   pattern: ^(?!server$)[a-zA-Z0-9_.:-]*$

dn

Distinguished name of the client.

Use: Required

JSON Schema:

   Object
   type: string
   minLength: 1
   maxLength: 241
   pattern: ^(([a-zA-Z]+=[a-zA-Z0-9_@.-]+( +[a-zA-Z0-9_@.-]+)*/?)+)$

Responses

204

Successful.

400

FRAMEWORK_BAD_REQUEST

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

404

NTLS_NO_CLIENT

The client does not exist.

422

NTLS_CLIENT_INVALID_DISTINGUISHED_NAME

Distinguished name provided is invalid.

500

NTLS_CLIENT_FAILED_TO_ASSIGN_DN_FILTER

Failed to add distinguished name filter.

Example Request

   PUT
   https://1.2.3.4:8443/api/lunasa/ntls/clients/testClient/dn
   {
      "dn": "C=CA/ST=Ontario/L=Ottawa/O=My company/DC=thales/DC=com"
   }

Example Result

{
}

Notes

This resource will require SO authentication when the forceSoLogin flag is enabled. (See GET /api/lunasa)