aam authentication relay form-based instance request-uri¶
URI of authentication web page
request-uri Specification¶
Parameter Value Type Collection Object Key(s) match-type, uri Collection Name request-uri-list Collection URI /axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri Element Name request-uri Element URI /axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri/{match-type}+{uri} Element Attributes request-uri_attributes Partition Visibility shared Schema request-uri schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri | ||
Create List | POST | /axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri | ||
Get Object | GET | /axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri/{match-type}+{uri} | ||
Get List | GET | /axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri | ||
Modify Object | POST | /axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri/{match-type}+{uri} | ||
Replace Object | PUT | /axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri/{match-type}+{uri} | ||
Replace List | PUT | /axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri | ||
Delete Object | DELETE | /axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri/{match-type}+{uri} |
request-uri-list¶
request-uri-list is JSON List of request-uri attributes
request-uri-list : [
]
request-uri attributes¶
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 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
cookie¶
Specification Value Type object cookie-value
Description: cookie-value is a JSON Block. Please see below for cookie_cookie-value
Type: Object
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