This is an archive version of the document. To get the most up-to-date information, see the current version.

Adding Passwords

You can add a new encryption password.

Request

POST https://<hostname>:4443/v5/EncryptionKeys

Request Headers

The request header must contain an authorization token of the current session.

Request Body

The following table lists available request properties:

Property

Type

Description

password

string

Specifies the encryption password.

description

string

Specifies the hint of the encryption password.

Request Example

Request:

POST https://abc.tech.local:4443/v5/EncryptionKeys/

 

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

  "password": "123qweASD",

  "description": "Developer 1"

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 201 Created.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

The response contains the following information:

Property

Type

Description

id

string

Specifies the encryption password ID.

description

string

Specifies the hint of the encryption password.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Response Example

Response:

201 Created

 

Response Body:

{

  "id": "7827a047-33ac-4d20-a8d8-1cd283755044",

  "description": "Developer 1",

  "_links": {"self": {"href": "https://abc.tech.local:4443/v5/encryptionkeys/7827a047-33ac-4d20-a8d8-1cd283755044"}}

}