.. _aam_authentication_relay_form_based: aam authentication relay form-based =================================== Form-based Authentication Relay form-based Specification ------------------------ ===================================== ============================================================================ **Parameter** **Value** ===================================== ============================================================================ **Type** *Intermediate Resource* **Element Name** form-based **Element URI** /axapi/v3/aam/authentication/relay/form-based **Element Attributes** form-based_attributes **Partition Visibility** shared **Schema** :download:`form-based schema ` ===================================== ============================================================================ **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/aam/authentication/relay/form-based .. raw:: html form-based_attributes .. raw:: html
.. _49_form-based_attributes: form-based attributes --------------------- **instance-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/aam/authentication/relay/form-based/instance/{name} ` .. _49_instance-list: instance-list ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **name** **Description** Specify form-based authentication relay name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **packet-capture-template** **Description** Name of the packet capture template to be bind with this object **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/aam-auth-relay-form-inst-tmpl ` **request-uri-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri/{match-type}+{uri} ` **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _49_instance-list_sampling-enable: instance-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'request': Request; 'invalid_srv_rsp': Invalid Server Response; 'post_fail': POST Failed; 'invalid_cred': Invalid Credential; 'bad_req': Bad Request; 'not_fnd': Not Found; 'error': Internal Server Error; 'other_error': Other Error; **Type:** string **Supported Values:** all, request, invalid_srv_rsp, post_fail, invalid_cred, bad_req, not_fnd, error, other_error .. _49_instance-list_request-uri-list: instance-list_request-uri-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action-uri** **Description** Specify the action-URI **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **cookie** **Description:** cookie is a **JSON Block**. Please see below for :ref:`49_instance-list_request-uri-list_cookie` **Type:** Object **domain-variable** **Description** Specify domain variable name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **match-type** **Description** 'equals': URI exactly matches the string; 'contains': URI string contains another sub string; 'starts-with': URI string starts with sub string; 'ends-with': URI string ends with sub string; **Type:** string **Supported Values:** equals, contains, starts-with, ends-with **max-packet-collect-size** **Description** Specify the max packet collection size in bytes, default is 1MB **Type:** number **Range:** 1024-2097152 **Default:** 1048576 **other-variables** **Description** Specify other variables (n1=v1&n2=v2) in form relay **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **password-variable** **Description** Specify password variable name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uri** **Description** Specify request URI **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **user-variable** **Description** Specify username variable name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _49_instance-list_request-uri-list_cookie: instance-list_request-uri-list_cookie ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cookie-value** **Description:** cookie-value is a **JSON Block**. Please see below for :ref:`49_instance-list_request-uri-list_cookie_cookie-value` **Type:** Object .. _49_instance-list_request-uri-list_cookie_cookie-value: instance-list_request-uri-list_cookie_cookie-value ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cookie-value** **Description** Specify cookie in POST packet **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters