aam authentication relay http-basic instance¶
HTTP Basic Authentication Relay instance
instance Specification¶
Type Collection Object Key(s) name Collection Name instance-list Collection URI /axapi/v3/aam/authentication/relay/http-basic/instance Element Name instance Element URI /axapi/v3/aam/authentication/relay/http-basic/instance/{name} Element Attributes instance_attributes Statistics Data URI /axapi/v3/aam/authentication/relay/http-basic/instance/{name}/stats Schema instance schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Create Object | POST | /axapi/v3/aam/authentication/relay/http-basic/instance | ||
Create List | POST | /axapi/v3/aam/authentication/relay/http-basic/instance | ||
Get Object | GET | /axapi/v3/aam/authentication/relay/http-basic/instance/{name} | ||
Get List | GET | /axapi/v3/aam/authentication/relay/http-basic/instance | ||
Modify Object | POST | /axapi/v3/aam/authentication/relay/http-basic/instance/{name} | ||
Replace Object | PUT | /axapi/v3/aam/authentication/relay/http-basic/instance/{name} | ||
Replace List | PUT | /axapi/v3/aam/authentication/relay/http-basic/instance | ||
Delete Object | DELETE | /axapi/v3/aam/authentication/relay/http-basic/instance/{name} |
instance-list¶
instance-list is JSON List of instance attributes
instance-list : [
]
instance attributes¶
domain
Description Specify user domain, default is null
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
domain-format
Description ‘user-principal-name’: Append domain with User Principal Name format. (e.g. user@domain); ‘down-level-logon-name’: Append domain with Down-Level Logon Name format. (e.g. domainuser);
Type: string
Supported Values: user-principal-name, down-level-logon-name
Default: down-level-logon-name
name
Description Specify HTTP basic 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-hbase-inst-tmpl
sampling-enable
Type: Listuuid
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; ‘success’: Success; ‘no-creds’: No Credential; ‘bad-req’: Bad Request; ‘unauth’: Unauthorized; ‘forbidden’: Forbidden; ‘not-found’: Not Found; ‘server-error’: Internal Server Error; ‘unavailable’: Service Unavailable;
Type: string
Supported Values: all, success, no-creds, bad-req, unauth, forbidden, not-found, server-error, unavailable
stats data¶
Counter | Size | Description | |
---|---|---|---|
bad-req | 8 | Bad Request | |
unavailable | 8 | Service Unavailable | |
success | 8 | Success | |
forbidden | 8 | Forbidden | |
no-creds | 8 | No Credential | |
server-error | 8 | Internal Server Error | |
not-found | 8 | Not Found | |
unauth | 8 | Unauthorized |