aam authentication logon http-authenticate instance¶

HTTP-authenticate Logon

instance Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name instance-list

Collection URI /axapi/v3/aam/authentication/logon/http-authenticate/instance

Element Name instance

Element URI /axapi/v3/aam/authentication/logon/http-authenticate/instance/{name}

Element Attributes instance_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/aam/authentication/logon/http-authenticate/instance/{name}/stats

Schema instance schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/aam/authentication/logon/http-authenticate/instance	instance attributes
POST /axapi/v3/aam/authentication/logon/http-authenticate/instance/ Payload: { "instance": { "name": "a", "auth-method": { "basic": { "basic-realm": "a" } } } }
Create List	POST	/axapi/v3/aam/authentication/logon/http-authenticate/instance	instance attributes
Get Object	GET	/axapi/v3/aam/authentication/logon/http-authenticate/instance/{name}	instance attributes
GET /axapi/v3/aam/authentication/logon/http-authenticate/instance/a Reponse: { "instance": { "name": "a", "auth-method": { "basic": { "basic-realm": "a", "basic-enable": 0 }, "ntlm": { "ntlm-enable": 0 }, "negotiate": { "negotiate-enable": 0 } }, "retry": 3, "account-lock": 0, "uuid": "d9990892-4f53-11ee-bde4-3768133b9b1a", "a10-url": "/axapi/v3/aam/authentication/logon/http-authenticate/instance/a" } }
Get List	GET	/axapi/v3/aam/authentication/logon/http-authenticate/instance	instance-list
Modify Object	POST	/axapi/v3/aam/authentication/logon/http-authenticate/instance/{name}	instance attributes
Replace Object	PUT	/axapi/v3/aam/authentication/logon/http-authenticate/instance/{name}	instance attributes
PUT /axapi/v3/aam/authentication/logon/http-authenticate/instance/a Payload: { "instance": { "name": "a", "auth-method": { "basic": { "basic-realm": "abcd" } } } }
Replace List	PUT	/axapi/v3/aam/authentication/logon/http-authenticate/instance	instance-list
Delete Object	DELETE	/axapi/v3/aam/authentication/logon/http-authenticate/instance/{name}	instance attributes
DELETE /axapi/v3/aam/authentication/logon/http-authenticate/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¶

account-lock

Description Lock the account when the failed logon attempts is exceeded

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

auth-method

Description: auth-method is a JSON Block. Please see below for auth-method

Type: Object

duration

Description The time an account remains locked in seconds (default 1800)

Type: number

Range: 1-86400

Default: 1800

hsts-timeout

Description Set HSTS policy expired timeout in seconds, 0 means to disable HSTS policy

Type: number

Range: 0-315360000

name

Description Specify HTTP-Authenticate logon name

Type: string

Format: string-rlx

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-logon-http-ins-tmpl

retry

Description Maximum number of consecutive failed logon attempts (default 3)

Type: number

Range: 1-32

Default: 3

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; ‘spn_krb_request’: SPN Kerberos Request; ‘spn_krb_success’: SPN Kerberos Success; ‘spn_krb_faiure’: SPN Kerberos Failure;

Type: string

Supported Values: all, spn_krb_request, spn_krb_success, spn_krb_faiure

auth-method¶

Specification Value

Type object

basic

Description: basic is a JSON Block. Please see below for auth-method_basic

Type: Object

negotiate

Description: negotiate is a JSON Block. Please see below for auth-method_negotiate

Type: Object

ntlm

Description: ntlm is a JSON Block. Please see below for auth-method_ntlm

Type: Object

auth-method_ntlm¶

Specification Value

Type object

ntlm-enable

Description Enable NTLM logon

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

auth-method_negotiate¶

Specification Value

Type object

negotiate-enable

Description Enable SPENGO logon

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

auth-method_basic¶

Specification Value

Type object

basic-enable

Description Enable Basic logon

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

basic-realm

Description Specify realm for basic logon

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

challenge-page

Description Specify challenge page name for RSA-RADIUS

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: challenge-page and new-pin-page are mutually exclusive

challenge-response-form

Description Specify challenge-response form for RSA-RADIUS authentication

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

challenge-variable

Description Specify challenge variable name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

new-pin-page

Description Specify new PIN page name for RSA-RADIUS

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: new-pin-page and challenge-page are mutually exclusive

new-pin-variable

Description Specify new PIN variable name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

next-token-page

Description Specify next-token page name for RSA-RADIUS

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

next-token-variable

Description Specify next-token variable name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters