ADM NITRO APIs

certificate_authority_management

June 20, 2023

Contributed by:

Configuration for Third party certificate authority management resource.

Properties

(click to see Operations )

Name	Permissions	Description
is_deploy	Read-write	Whether Auto deployment of certificates managed by third party CA should be done by ADM.Should be set only if is_renew is true..
policy_folder	Read-write	Policy Folder.Applicable only if the CA provider is Venafi.
ca_provider	Read-write	CA provider.Possible values are: Venafi.
renew_before_days	Read-write	Number of days before which certificates managed by third party CA should be renewed by ADM.Should be set only if is_renew is true..
refresh_token	Read-write	Before the access token expires, application uses the refresh token to get a new set of tokens.
client_id	Read-write	Client id required to make API calls to third party CA management server.
access_token	Read-write	Access token is passed in the header of every API call.
name	Read-write	Name to identify the third party CA management server..
device_folder	Read-write	Device Folder.Applicable only if the CA provider is Venafi.
is_renew	Read-write	Whether Auto renewal of certificates managed by third party CA should be done by ADM..
agent_id	Read-write	Id of the agent which connects to third party CA management server.
api_endpoint	Read-write	WebSDK endpoint for the configured third party CA management server..
passphrase	Read-write	password with which the cert/key file will be encrypted when downloading from third party CA management server.
id	Read-write	Id is system generated key for all third party CA management resource..
policy_folder_list	Read-write	Comma separated list of policies available under policy_folder. Applicable only if the CA provider is Venafi..

Operations

(click to see Properties )

ADD
DELETE
GET (ALL)
MODIFY
GET_POLICY_FOLDERS

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

To do this, you must specify the username and password in the request header of the NITRO request as follows:

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

Note: In such cases, make sure that the request header DOES not include the following:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note:* Mandatory parameters are marked in red and placeholder content is marked in green

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

add

URL: https://<MGMT-IP>/nitro/v2/config/certificate_authority_management?onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"certificate_authority_management": {
<b>"ca_provider":<String_value></b>,
<b>"refresh_token":<String_value></b>,
<b>"client_id":<String_value></b>,
<b>"access_token":<String_value></b>,
<b>"name":<String_value></b>,
<b>"api_endpoint":<String_value></b>,
<b>"passphrase":<String_value></b>,
"policy_folder":<String_value>,
"renew_before_days":<Integer_value>,
"device_folder":<String_value>,
"is_renew":<Boolean_value>,
"id":<String_value>,
"policy_folder_list":<String_value>,
"is_deploy":<Boolean_value>,
"agent_id":<String_value>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "certificate_authority_management":[{
"is_deploy":<Boolean_value>,
"policy_folder":<String_value>,
"ca_provider":<String_value>,
"renew_before_days":<Integer_value>,
"refresh_token":<String_value>,
"client_id":<String_value>,
"access_token":<String_value>,
"name":<String_value>,
"device_folder":<String_value>,
"is_renew":<Boolean_value>,
"agent_id":<String_value>,
"api_endpoint":<String_value>,
"passphrase":<String_value>,
"id":<String_value>,
"policy_folder_list":<String_value>,
"policy_folder_array":<String_value>}]}

<!--NeedCopy-->

delete

URL: https://<MGMT-IP>/nitro/v2/config/certificate_authority_management/id_value<String> HTTPS Method: DELETE

Request Headers: X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

<!--NeedCopy-->

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/certificate_authority_management Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/certificate_authority_management ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of certificate_authority_management resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/certificate_authority_management ?pagesize=#no;pageno=#no Use this query-parameter to get the certificate_authority_management resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/certificate_authority_management ?count=yes Use this query-parameter to get the count of certificate_authority_management resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "certificate_authority_management":[{
"is_deploy":<Boolean_value>,
"policy_folder":<String_value>,
"ca_provider":<String_value>,
"renew_before_days":<Integer_value>,
"refresh_token":<String_value>,
"client_id":<String_value>,
"access_token":<String_value>,
"name":<String_value>,
"device_folder":<String_value>,
"is_renew":<Boolean_value>,
"agent_id":<String_value>,
"api_endpoint":<String_value>,
"passphrase":<String_value>,
"id":<String_value>,
"policy_folder_list":<String_value>,
"policy_folder_array":<String_value>}]}

<!--NeedCopy-->

modify

URL: https://<MGMT-IP>/nitro/v2/config/certificate_authority_management/id_value<String> HTTPS Method: PUT

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"certificate_authority_management":{
<b>"id":<String_value></b>,
"policy_folder":<String_value>,
"refresh_token":<String_value>,
"renew_before_days":<Integer_value>,
"device_folder":<String_value>,
"is_renew":<Boolean_value>,
"api_endpoint":<String_value>,
"passphrase":<String_value>,
"policy_folder_list":<String_value>,
"is_deploy":<Boolean_value>,
"ca_provider":<String_value>,
"name":<String_value>,
"access_token":<String_value>,
"client_id":<String_value>,
"agent_id":<String_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "certificate_authority_management":[{
"is_deploy":<Boolean_value>,
"policy_folder":<String_value>,
"ca_provider":<String_value>,
"renew_before_days":<Integer_value>,
"refresh_token":<String_value>,
"client_id":<String_value>,
"access_token":<String_value>,
"name":<String_value>,
"device_folder":<String_value>,
"is_renew":<Boolean_value>,
"agent_id":<String_value>,
"api_endpoint":<String_value>,
"passphrase":<String_value>,
"id":<String_value>,
"policy_folder_list":<String_value>,
"policy_folder_array":<String_value>}]}

<!--NeedCopy-->

get_policy_folders

URL: https://<MGMT-IP>/nitro/v2/config/certificate_authority_management?action=get_policy_folders;onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"certificate_authority_management": {
"policy_folder":<String_value>,
"refresh_token":<String_value>,
"renew_before_days":<Integer_value>,
"device_folder":<String_value>,
"is_renew":<Boolean_value>,
"api_endpoint":<String_value>,
"id":<String_value>,
"passphrase":<String_value>,
"policy_folder_list":<String_value>,
"is_deploy":<Boolean_value>,
"ca_provider":<String_value>,
"name":<String_value>,
"access_token":<String_value>,
"client_id":<String_value>,
"agent_id":<String_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "certificate_authority_management":[{
"is_deploy":<Boolean_value>,
"policy_folder":<String_value>,
"ca_provider":<String_value>,
"renew_before_days":<Integer_value>,
"refresh_token":<String_value>,
"client_id":<String_value>,
"access_token":<String_value>,
"name":<String_value>,
"device_folder":<String_value>,
"is_renew":<Boolean_value>,
"agent_id":<String_value>,
"api_endpoint":<String_value>,
"passphrase":<String_value>,
"id":<String_value>,
"policy_folder_list":<String_value>,
"policy_folder_array":<String_value>}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

certificate_authority_management

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

certificate_authority_management

Properties

Operations

add

delete

get (all)

modify

get_policy_folders

In this article