49 lines
12 KiB
HTML
49 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>certificate_policy</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">certificate_policy</p>
|
|
<P>Configuration for Venafi certificate policy resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">name<span class="property_type"><String></span></p><p class="property_description">Name of the Venafi server configured..</p>
|
|
<p class="property_name">org_unit<span class="property_type"><String[]></span></p><p class="property_description">Organization Unit.</p>
|
|
<p class="property_name">is_key_generation_locked<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if the key generation value is locked in the policy.</p>
|
|
<p class="property_name">policy<span class="property_type"><String></span></p><p class="property_description">Policy folder path which determines the certificate attributes..</p>
|
|
<p class="property_name">csr_generation<span class="property_type"><String></span></p><p class="property_description">CSR generation.Possible values: ServiceGenerated, UserGenerated.</p>
|
|
<p class="property_name">state<span class="property_type"><String></span></p><p class="property_description">State.</p>
|
|
<p class="property_name">key_value<span class="property_type"><String></span></p><p class="property_description">Key strength if algorithm is RSA. EllipticCurve ,if the algorithm is ECC .</p>
|
|
<p class="property_name">subjaltname_ip_allowed<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if IP subject alternative names allowed.</p>
|
|
<p class="property_name">tp_renewal<span class="property_type"><Boolean></span></p><p class="property_description">set to True, if automatic renewal is enabled in Venafi.</p>
|
|
<p class="property_name">subjaltname_uri_allowed<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if URI subject alternative names allowed.</p>
|
|
<p class="property_name">keypair_algorithm<span class="property_type"><String></span></p><p class="property_description">Algorithm for generating the key. Possible values: ECC, RSA.</p>
|
|
<p class="property_name">subjaltname_dns_allowed<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if DNS subject alternative names allowed.</p>
|
|
<p class="property_name">is_city_locked<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if the city value is locked.</p>
|
|
<p class="property_name">is_csr_generation_locked<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if the CsrGeneration value is locked in the policy.</p>
|
|
<p class="property_name">management_type<span class="property_type"><String></span></p><p class="property_description">Management Type.</p>
|
|
<p class="property_name">tp_renewal_locked<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if TpRenewal is locked.</p>
|
|
<p class="property_name">is_org_locked<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if the organization value is locked.</p>
|
|
<p class="property_name">country<span class="property_type"><String></span></p><p class="property_description">country.</p>
|
|
<p class="property_name">is_management_type_locked<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if management type is locked.</p>
|
|
<p class="property_name">is_org_unit_locked<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if the organization unit value is locked.</p>
|
|
<p class="property_name">is_country_locked<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if the country value is locked.</p>
|
|
<p class="property_name">wildcards_allowed<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if wild cards is allowed.</p>
|
|
<p class="property_name">subjaltname_upn_allowed<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if UPN subject alternative names allowed.</p>
|
|
<p class="property_name">is_state_locked<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if the state value is locked.</p>
|
|
<p class="property_name">is_key_value_locked<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if the algorithm property value is locked in the policy.</p>
|
|
<p class="property_name">is_ca_locked<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if the CA value is locked in the policy.</p>
|
|
<p class="property_name">key_generation<span class="property_type"><String></span></p><p class="property_description">Key generation value.</p>
|
|
<p class="property_name">is_keypair_algorithm_locked<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if the key pair algorithm value is locked in the policy.</p>
|
|
<p class="property_name">org<span class="property_type"><String></span></p><p class="property_description">Organization.</p>
|
|
<p class="property_name">subjaltname_email_allowed<span class="property_type"><Boolean></span></p><p class="property_description">Indicates if Email subject alternative names allowed.</p>
|
|
<p class="property_name">ca<span class="property_type"><String></span></p><p class="property_description">Certificate Authority.</p>
|
|
<p class="property_name">city<span class="property_type"><String></span></p><p class="property_description">city.</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/certificate_policy</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/certificate_policy<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of certificate_policy resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/certificate_policy<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the certificate_policy resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/certificate_policy<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of certificate_policy resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "certificate_policy":[{<br> "name":<String_value></font>,<br> "org_unit":<String_value></font>,<br> "is_key_generation_locked":<Boolean_value></font>,<br> "policy":<String_value></font>,<br> "csr_generation":<String_value></font>,<br> "state":<String_value></font>,<br> "key_value":<String_value></font>,<br> "subjaltname_ip_allowed":<Boolean_value></font>,<br> "tp_renewal":<Boolean_value></font>,<br> "subjaltname_uri_allowed":<Boolean_value></font>,<br> "keypair_algorithm":<String_value></font>,<br> "subjaltname_dns_allowed":<Boolean_value></font>,<br> "is_city_locked":<Boolean_value></font>,<br> "is_csr_generation_locked":<Boolean_value></font>,<br> "management_type":<String_value></font>,<br> "tp_renewal_locked":<Boolean_value></font>,<br> "is_org_locked":<Boolean_value></font>,<br> "country":<String_value></font>,<br> "is_management_type_locked":<Boolean_value></font>,<br> "is_org_unit_locked":<Boolean_value></font>,<br> "is_country_locked":<Boolean_value></font>,<br> "wildcards_allowed":<Boolean_value></font>,<br> "subjaltname_upn_allowed":<Boolean_value></font>,<br> "is_state_locked":<Boolean_value></font>,<br> "is_key_value_locked":<Boolean_value></font>,<br> "is_ca_locked":<Boolean_value></font>,<br> "key_generation":<String_value></font>,<br> "is_keypair_algorithm_locked":<Boolean_value></font>,<br> "org":<String_value></font>,<br> "subjaltname_email_allowed":<Boolean_value></font>,<br> "ca":<String_value></font>,<br> "city":<String_value></font>}]}</p>
|
|
</body>
|
|
</html>
|