aam authentication relay form-based

Form-based Authentication Relay

form-based Specification

Type Intermediate Resource
Element Name form-based
Element URI /axapi/v3/aam/authentication/relay/form-based
Element Attributes form-based_attributes
Schema form-based schema

Operations Allowed:

Operation Method URI Payload

Get Object

GET

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

form-based_attributes

form-based Attributes

instance-list

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

Type: List

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

instance-list

Specification
Type list
Block object keys

name

Description: Specify form-based authentication relay name

Type: string

request-uri-list

Description: request-uri-list is a JSON List . Please see below for l1065_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 l1065_sampling-enable

Type: List

uuid

Description: uuid of the object

Type: string

instance-list.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

instance-list.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 l1065_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