Product Documentation

ssl_store

Oct 21, 2015

Configuration of SSL Store

Properties

Name Data Type Read-Only? Description
passwordconfigured
<Boolean>
Yes

Boolean stating if password has been ever configured on the box. Use key passwordenabled to either enable password or disable using password.

Possible values = [true, false]

storepassword
<String>
No

Password used to enable password or disable (once enabled) password or open key store once password is set. To change password, first disable password and then enable using new password.

passwordenabled
<Boolean>
No

Boolean used to get/set state of store password. Should be accompanied with a storeopened and storepassword keys.

Possible values = [true, false]

diskencryption
<Boolean>
No

Boolean to get/set state of disk encryption. Turn ON needs an open key store.

Possible values = [true, false]

storeopened
<Boolean>
No

Boolean used to get/set state of store. Store open needs a storepassword.

Possible values = [true, false]

Operations

Hinweis

Mandatory parameters are marked in red and placeholder content is marked in <green>.

GET

Use this operation to get SSL store state/password and disk encryption

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/ssl_store/

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.ssl_store+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.ssl_store+json

Response Payload: JSON

{"ssl_store":{
"passwordconfigured": <boolean_value>,
"storepassword": <string_value>,
"passwordenabled": <boolean_value>,
"diskencryption": <boolean_value>,
"storeopened": <boolean_value>
}}

MODIFY

Use this operation to modify SSL store state/password and disk encryption

HTTP Method: PUT

URL: https://<cb_ip_address>/cb/nitro/v1/config/ssl_store

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.ssl_store+json

Request Payload: JSON

{"ssl_store":{
"storepassword": <string_value>,
"passwordenabled": <boolean_value>,
"diskencryption": <boolean_value>,
"storeopened": <boolean_value>
}}

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.ssl_store+json

Response Payload: JSON

{"ssl_store":{
"passwordconfigured": <boolean_value>,
"storepassword": <string_value>,
"passwordenabled": <boolean_value>,
"diskencryption": <boolean_value>,
"storeopened": <boolean_value>
}}