aam authentication relay form-based instance

Form-based Authentication Relay

This object allows you to set a Form-base Authentication Relay name.

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:

Operation Method URI Payload

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

Get Stats

GET

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

stats data

instance-list

instance-list is JSON List of instance Attributes

instance-list : [

instance Attributes

name

Description: Provide a name for the form-based authentication relay profile.

Type: string

Required: Yes

request-uri-list

Description: request-uri-list is a JSON List . Please see below for request-uri-list

Type: List

Reference Object: /axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri/{match-type}+{uri}

sampling-enable

Description: sampling-enable is a JSON List . Please see below for sampling-enable

Type: List

uuid

Description: uuid of the object

Type: string

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

cookie

Description: cookie is a JSON Block . Please see below for l1064_cookie

Type: Object

domain-variable

Description: Specify domain variable name

Type: string

Format: string-rlx

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

other-variables

Description: Specify other variables (n1=v1&n2=v2) in form relay

Type: string

Format: string-rlx

password-variable

Description: Specify password variable name

Type: string

Format: string-rlx

uri

Description: Specify request URI

Type: string

Format: string-rlx

user-tag

Description: Customized tag

Type: string

Format: string-rlx

user-variable

Description: Specify username variable name

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

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