aam authentication relay ntlm¶
NTLM Authentication Relay
ntlm Specification¶
Type
Collection
Object Key(s)
name
Collection Name
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
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/aam/authentication/relay/ntlm | ||
Create List | POST | /axapi/v3/aam/authentication/relay/ntlm | ||
Get Object | GET | /axapi/v3/aam/authentication/relay/ntlm/{name} | ||
Get List | GET | /axapi/v3/aam/authentication/relay/ntlm | ||
Modify Object | POST | /axapi/v3/aam/authentication/relay/ntlm/{name} | ||
Replace Object | PUT | /axapi/v3/aam/authentication/relay/ntlm/{name} | ||
Replace List | PUT | /axapi/v3/aam/authentication/relay/ntlm | ||
Delete Object | DELETE | /axapi/v3/aam/authentication/relay/ntlm/{name} |
ntlm-list¶
ntlm-list is JSON List of ntlm attributes
ntlm-list : [
]
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
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
stats data¶
Counter |
Size |
Description |
|
|---|---|---|---|
parse-header-fail |
8 |
Parse Header Failure |
|
ntlm-auth-skipped |
8 |
Requests for which NTLM relay is skipped |
|
head-negotiate-request-sent |
8 |
HEAD requests sent with NEGOTIATE header |
|
http-code-other |
8 |
Other HTTP Response |
|
internal-error |
8 |
Internal Error |
|
buffer-alloc-fail |
8 |
Buffer Allocation Failure |
|
failure |
8 |
Failure |
|
http-code-400 |
8 |
HTTP 400 Bad Request |
|
http-code-401 |
8 |
HTTP 401 Unauthorized |
|
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 |
|
large-request-processing |
8 |
Requests invoking large request processing |
|
response |
8 |
Response |
|
head-auth-request-sent |
8 |
HEAD requests sent with AUTH header |
|
http-code-200 |
8 |
HTTP 200 OK |
|
success |
8 |
Success |
|
encoding-fail |
8 |
Encoding Failure |
|
request |
8 |
Request |
|
large-request-flushed |
8 |
Large requests sent to server |
|
insert-header-fail |
8 |
Insert Header Failure |