aam authentication relay http-basic instance¶

HTTP Basic Authentication Relay instance

instance Specification¶

Parameter Value

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

Partition Visibility shared

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	instance attributes
POST /axapi/v3/aam/authentication/relay/http-basic/instance/ Payload: { "instance": { "name": "a", "domain": "a" } }
Create List	POST	/axapi/v3/aam/authentication/relay/http-basic/instance	instance attributes
Get Object	GET	/axapi/v3/aam/authentication/relay/http-basic/instance/{name}	instance attributes
GET /axapi/v3/aam/authentication/relay/http-basic/instance/a Reponse: { "instance": { "name": "a", "domain": "a", "domain-format": "down-level-logon-name", "uuid": "c77f1ddc-4f57-11ee-bde4-3768133b9b1a", "a10-url": "/axapi/v3/aam/authentication/relay/http-basic/instance/a" } }
Get List	GET	/axapi/v3/aam/authentication/relay/http-basic/instance	instance-list
Modify Object	POST	/axapi/v3/aam/authentication/relay/http-basic/instance/{name}	instance attributes
Replace Object	PUT	/axapi/v3/aam/authentication/relay/http-basic/instance/{name}	instance attributes
PUT /axapi/v3/aam/authentication/relay/http-basic/instance/a Payload: { "instance": { "name": "a", "domain": "abcd" } }
Replace List	PUT	/axapi/v3/aam/authentication/relay/http-basic/instance	instance-list
Delete Object	DELETE	/axapi/v3/aam/authentication/relay/http-basic/instance/{name}	instance attributes
DELETE /axapi/v3/aam/authentication/relay/http-basic/instance/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

instance-list¶

instance-list is JSON List of instance attributes

instance-list : [

{ instance attributes },

{ instance attributes },

…

]

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: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

sampling-enable¶

Specification Value

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