aam authentication relay ntlm

NTLM Authentication Relay

ntlm Specification

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

Get Stats

GET

/axapi/v3/aam/authentication/relay/ntlm/{name}/stats

stats data

ntlm-list

ntlm-list is JSON List of ntlm Attributes

ntlm-list : [

ntlm Attributes

domain

Description: Domain of the Active Directory server for NTLM authentication.

Type: string

name

Description: Specify a name for the NTLM authentication relay profile.

Type: string

Required: Yes

sampling-enable

Description: sampling-enable is a JSON List . Please see below for sampling-enable

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

version

Description: Specify the version number of the NTLM relay.

Type: number

Range: 1-2

Default: 2

sampling-enable

Specification
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;

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

stats data

Counter Size Description
http-code-other 8 Other HTTP Response
success 8 Success
http-code-200 8 HTTP 200 OK
http-code-401 8 HTTP 401 Unauthorized
internal-error 8 Internal Error
parse-header-fail 8 Parse Header Failure
request 8 Request
encoding-fail 8 Encoding Failure
http-code-400 8 HTTP 400 Bad Request
failure 8 Failure
buffer-alloc-fail 8 Buffer Allocation Failure
http-code-403 8 HTTP 403 Forbidden
http-code-404 8 HTTP 404 Not Found
http-code-500 8 HTTP 500 Internal Server Error
http-code-503 8 HTTP 503 Service Unavailable
response 8 Response
insert-header-fail 8 Insert Header Failure