.. _aam_authentication_server_ocsp:

aam authentication server ocsp
==============================

OCSP Authentication Server


ocsp Specification
------------------

	===================================== =======================================================================
	===================================== =======================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      ocsp

	 **Element URI**                       /axapi/v3/aam/authentication/server/ocsp

	 **Element Attributes**                ocsp_attributes

	 **Statistics Data URI**               /axapi/v3/aam/authentication/server/ocsp/stats

	 **Schema**                             :download:`ocsp schema <aam-authentication-server-ocsp/aam-authentication-server-ocsp.txt>`
	===================================== =======================================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/aam/authentication/server/ocsp



.. raw:: html

   </td><td valign = 'top'>


:ref:`290_ocsp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/aam/authentication/server/ocsp



.. raw:: html

   </td><td valign = 'top'>


:ref:`290_ocsp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/aam/authentication/server/ocsp



.. raw:: html

   </td><td valign = 'top'>


:ref:`290_ocsp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/aam/authentication/server/ocsp



.. raw:: html

   </td><td valign = 'top'>


:ref:`290_ocsp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/aam/authentication/server/ocsp



.. raw:: html

   </td><td valign = 'top'>


:ref:`290_ocsp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _290_ocsp_attributes:

ocsp attributes
---------------

    **instance-list**

        **Type:** List

        **Refernce Object:** :doc:`/axapi/v3/aam/authentication/server/ocsp/instance/{name} <aam_authentication_server_ocsp_instance>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _290_instance-list:

instance-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **health-check**

        **Description** Check server's health status

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** health-check and health-check-disable are mutually exclusive

    **health-check-disable**

        **Description** Disable configured health check configuration

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** health-check-disable and health-check are mutually exclusive

    **health-check-string**

        **Description** Health monitor name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Refernce Object:** :doc:`/axapi/v3/health/monitor <health_monitor>`

    **http-version**

        **Description** Set HTTP version (default 1.0)

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **name**

        **Description** Specify OCSP authentication server name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **port-health-check**

        **Description** Check port's health status

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** port-health-check and port-health-check-disable are mutually exclusive

        **Refernce Object:** :doc:`/axapi/v3/health/monitor <health_monitor>`

    **port-health-check-disable**

        **Description** Disable configured port health check configuration

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** port-health-check-disable and port-health-check are mutually exclusive

    **responder-ca**

        **Description** Specify the trusted OCSP responder's CA cert filename

        **Type:** string

        **Maximum Length:** 245 characters

        **Maximum Length:** 1 characters

    **responder-cert**

        **Description** Specify the trusted OCSP responder's cert filename

        **Type:** string

        **Maximum Length:** 245 characters

        **Maximum Length:** 1 characters

    **url**

        **Description** Specify the OCSP server's address (Format: http://host[:port]/) (The OCSP server's address(Format: http://host[:port]/))

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **version-type**

        **Description** '1.1': HTTP version 1.1; 

        **Type:** string

        **Supported Values:** 1.1

.. _290_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - stapling-request-normal
      - 8
      - Total OSCP Stapling Normal Request

   *  - 
      - request-normal
      - 8
      - Total OSCP Normal Request

   *  - 
      - polling-control-error
      - 8
      - Total OCSP Polling Control Error

   *  - 
      - stapling-response-other
      - 8
      - Total OCSP Stapling Other Response

   *  - 
      - stapling-certificate-revoked
      - 8
      - Total OCSP Stapling Revoked Certificate Response

   *  - 
      - stapling-response-failure
      - 8
      - Total OCSP Stapling Failure Response

   *  - 
      - stapling-response-timeout
      - 8
      - Total OCSP Stapling Timeout Response

   *  - 
      - stapling-response-error
      - 8
      - Total OCSP Stapling Error Response

   *  - 
      - stapling-certificate-unknown
      - 8
      - Total OCSP Stapling Unknown Certificate Response

   *  - 
      - response-other
      - 8
      - Total OCSP Other Response

   *  - 
      - stapling-certificate-good
      - 8
      - Total OCSP Stapling Good Certificate Response

   *  - 
      - response-failure
      - 8
      - Total OCSP Failure Response

   *  - 
      - stapling-response-success
      - 8
      - Total OCSP Stapling Success Response

   *  - 
      - response-timeout
      - 8
      - Total OCSP Timeout Response

   *  - 
      - request-dropped
      - 8
      - Total OCSP Dropped Request

   *  - 
      - response-success
      - 8
      - Total OCSP Success Response

   *  - 
      - job-start-error
      - 8
      - Total OCSP Job Start Error

   *  - 
      - response-error
      - 8
      - Total OCSP Error Response

   *  - 
      - stapling-request-dropped
      - 8
      - Total OCSP Stapling Dropped Request