aam authentication relay form-based instance

Form-based Authentication Relay

instance Specification

   
Type Collection
Object Key(s) name
Collection Name instance-list
Collection URI /axapi/v3/aam/authentication/relay/form-based/instance
Element Name instance
Element URI /axapi/v3/aam/authentication/relay/form-based/instance/{name}
Element Attributes instance_attributes
Statistics Data URI /axapi/v3/aam/authentication/relay/form-based/instance/{name}/stats
Schema instance schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/aam/authentication/relay/form-based/instance

instance attributes

Create List

POST

/axapi/v3/aam/authentication/relay/form-based/instance

instance attributes

Get Object

GET

/axapi/v3/aam/authentication/relay/form-based/instance/{name}

instance attributes

Get List

GET

/axapi/v3/aam/authentication/relay/form-based/instance

instance-list

Modify Object

POST

/axapi/v3/aam/authentication/relay/form-based/instance/{name}

instance attributes

Replace Object

PUT

/axapi/v3/aam/authentication/relay/form-based/instance/{name}

instance attributes

Replace List

PUT

/axapi/v3/aam/authentication/relay/form-based/instance

instance-list

Delete Object

DELETE

/axapi/v3/aam/authentication/relay/form-based/instance/{name}

instance attributes

instance-list

instance-list is JSON List of instance attributes

instance-list : [

instance attributes

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: /axapi/v3/visibility/packet-capture/object-templates/aam-auth-relay-form-inst-tmpl

request-uri-list

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

sampling-enable

Specification  
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

request-uri-list

Specification  
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 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

stats data

  Counter Size Description
       
  invalid_cred 8 Invalid Credential
  bad_req 8 Bad Request
  other_error 8 Other Error
  request 8 Request
  invalid_srv_rsp 8 Invalid Server Response
  post_fail 8 POST Failed
  error 8 Internal Server Error
  not_fnd 8 Not Found