aam authentication relay ntlm¶

NTLM Authentication Relay

ntlm Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name ntlm-list

Collection URI /axapi/v3/aam/authentication/relay/ntlm

Element Name ntlm

Element URI /axapi/v3/aam/authentication/relay/ntlm/{name}

Element Attributes ntlm_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/aam/authentication/relay/ntlm/{name}/stats

Schema ntlm schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/aam/authentication/relay/ntlm	ntlm attributes
Create List	POST	/axapi/v3/aam/authentication/relay/ntlm	ntlm attributes
Get Object	GET	/axapi/v3/aam/authentication/relay/ntlm/{name}	ntlm attributes
Get List	GET	/axapi/v3/aam/authentication/relay/ntlm	ntlm-list
Modify Object	POST	/axapi/v3/aam/authentication/relay/ntlm/{name}	ntlm attributes
Replace Object	PUT	/axapi/v3/aam/authentication/relay/ntlm/{name}	ntlm attributes
Replace List	PUT	/axapi/v3/aam/authentication/relay/ntlm	ntlm-list
Delete Object	DELETE	/axapi/v3/aam/authentication/relay/ntlm/{name}	ntlm attributes

ntlm-list¶

ntlm-list is JSON List of ntlm attributes

ntlm-list : [

{ ntlm attributes },

{ ntlm attributes },

…

]

ntlm attributes¶

domain

Description Specify NTLM domain, default is null

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

large-request-disable

Description Disable NTLM relay processing for large requests

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

name

Description Specify NTLM 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-ntlm-tmpl

sampling-enable

Type: List

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

version

Description Specify NTLM version, default is NTLM 2

Type: number

Range: 1-2

Default: 2

sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘success’: Success; ‘failure’: Failure; ‘request’: Request; ‘response’: Response; ‘http-code-200’: HTTP 200 OK; ‘http-code-400’: HTTP 400 Bad Request; ‘http-code-401’: HTTP 401 Unauthorized; ‘http-code-403’: HTTP 403 Forbidden; ‘http-code-404’: HTTP 404 Not Found; ‘http-code-500’: HTTP 500 Internal Server Error; ‘http-code-503’: HTTP 503 Service Unavailable; ‘http-code-other’: Other HTTP Response; ‘buffer-alloc-fail’: Buffer Allocation Failure; ‘encoding-fail’: Encoding Failure; ‘insert-header-fail’: Insert Header Failure; ‘parse-header-fail’: Parse Header Failure; ‘internal-error’: Internal Error; ‘ntlm-auth-skipped’: Requests for which NTLM relay is skipped; ‘large-request-processing’: Requests invoking large request processing; ‘large-request-flushed’: Large requests sent to server; ‘head-negotiate-request-sent’: HEAD requests sent with NEGOTIATE header; ‘head-auth-request-sent’: HEAD requests sent with AUTH header;

Type: string

Supported Values: all, success, failure, request, response, http-code-200, http-code-400, http-code-401, http-code-403, http-code-404, http-code-500, http-code-503, http-code-other, buffer-alloc-fail, encoding-fail, insert-header-fail, parse-header-fail, internal-error, ntlm-auth-skipped, large-request-processing, large-request-flushed, head-negotiate-request-sent, head-auth-request-sent