.. _aam_authentication_relay_kerberos_instance_oper:

aam authentication relay kerberos instance oper
===============================================

Operational Status for the object instance


instance Specification
----------------------

	===================================== ===============================================================================================
	 **Parameter**                         **Value** 

	===================================== ===============================================================================================
	 **Type**                              *Collection*

	 **Collection Name**                   :ref:`53_instance_list`

	 **Collection URI**                    /axapi/v3/aam/authentication/relay/kerberos/instance/{name}

	                                       

	 **Element Name**                      instance

	 **Element URI**                       /axapi/v3/aam/authentication/relay/kerberos/instance/{name}/oper

	 **Element Attributes**                instance_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`instance schema <aam-authentication-relay-kerberos-instance-oper/aam-authentication-relay-kerberos-instance-oper.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/relay/kerberos/instance/{name}



.. raw:: html

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


:ref:`53_instance_attributes`



.. raw:: html

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




.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/aam/authentication/relay/kerberos/instance/{name}



.. raw:: html

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


:ref:`53_instance_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/relay/kerberos/instance/{name}/oper



.. raw:: html

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


:ref:`53_instance_attributes`



.. raw:: html

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




.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/aam/authentication/relay/kerberos/instance/{name}



.. raw:: html

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


:ref:`53_instance_list`



.. 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/relay/kerberos/instance/{name}/oper



.. raw:: html

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


:ref:`53_instance_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/relay/kerberos/instance/{name}/oper



.. raw:: html

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


:ref:`53_instance_attributes`



.. raw:: html

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




.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/aam/authentication/relay/kerberos/instance/{name}



.. raw:: html

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


:ref:`53_instance_list`



.. 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/relay/kerberos/instance/{name}/oper



.. raw:: html

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


:ref:`53_instance_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _53_instance_list:

instance-list
-------------


    instance-list is **JSON List** of :ref:`53_instance_attributes` 

        instance-list : [

             { :ref:`53_instance_attributes` },

             { :ref:`53_instance_attributes` },

             ...

         ]

.. _53_instance_attributes:

instance attributes
-------------------

    **name**

        **Description** Specify Kerberos authentication relay name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`53_oper` 

        **Type:** Object

.. _53_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **default-principal**

        **Description** 

        **Type:** string

    **item-list**

        **Type:** List

    **ticket-cache**

        **Description** 

        **Type:** string

.. _53_oper_item-list:

oper_item-list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **client-principal**

        **Description** 

        **Type:** string

    **end-time**

        **Description** 

        **Type:** string

    **flags**

        **Description** 

        **Type:** string

    **renew-time**

        **Description** 

        **Type:** string

    **service-principal**

        **Description** 

        **Type:** string

    **start-time**

        **Description** 

        **Type:** string