aam authentication captcha¶
CAPTCHA Profile
captcha Specification¶
Type
Configuration Resource
Element Name
captcha
Element URI
/axapi/v3/aam/authentication/captcha
Element Attributes
captcha_attributes
Statistics Data URI
/axapi/v3/aam/authentication/captcha/stats
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/aam/authentication/captcha | ||
Get Object | GET | /axapi/v3/aam/authentication/captcha | ||
Modify Object | POST | /axapi/v3/aam/authentication/captcha | ||
Replace Object | PUT | /axapi/v3/aam/authentication/captcha | ||
Delete Object | DELETE | /axapi/v3/aam/authentication/captcha |
captcha attributes¶
instance-list
Type: List
Refernce Object: /axapi/v3/aam/authentication/captcha/instance/{name}
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
instance-list¶
Specification
Type
list
Block object keys
client-ip-param-name
Description Specify client ip parameter name used in API (Set parameter name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)
method
Description ‘POST’: API uses POST method; ‘GET’: API uses GET method;
Type: string
Supported Values: POST, GET
Default: POST
name
Description Specify captcha profile name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
resp-error-code-field-name
Description Specify error code field name used in JSON response (Set field name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
resp-result-field-name
Description Specify result field name used in JSON response (Set field name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
secret-key
Description Specify secret key
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
secret-key-param-name
Description Specify secret key parameter name used in API (Set parameter name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
secret-key-string
Description Secret key string
Type: string
Format: password
Maximum Length: 127 characters
Maximum Length: 1 characters
send-client-ip
Description Send client IP address in API
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
timeout
Description Specify timeout for verify API response (Specify timeout value, default is 10 seconds)
Type: number
Range: 1-255
Default: 10
token-param-name
Description Specify token parameter name used in API (Set parameter name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
url
Description Specify verify API URL, default scheme is https
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
stats data¶
Counter |
Size |
Description |
|
|---|---|---|---|
request-normal |
8 |
Total Normal Request |
|
response-success |
8 |
Total Success Response |
|
parse-fail |
8 |
Total JSON Response Parse Failure |
|
timeout-error |
8 |
Total Timeout |
|
request |
8 |
Total Request |
|
response-other |
8 |
Total Other Response |
|
response-failure |
8 |
Total Failure Response |
|
json-fail |
8 |
Total Failure JSON Response |
|
attr-fail |
8 |
Total Attribute Check Failure |
|
other-error |
8 |
Total Other Error |
|
request-dropped |
8 |
Total Dropped Request |
|
response-timeout |
8 |
Total Timeout Response |
|
job-start-error |
8 |
Total Job Start Error |
|
verify-succ |
8 |
Total Verification Success Response |
|
response-error |
8 |
Total Error Response |
|
polling-control-error |
8 |
Total Polling Control Error |