aam authentication captcha¶

CAPTCHA Profile

captcha Specification¶

Parameter Value

Type Configuration Resource

Element Name captcha

Element URI /axapi/v3/aam/authentication/captcha

Element Attributes captcha_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/aam/authentication/captcha/stats

Schema captcha schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/aam/authentication/captcha	captcha attributes
POST /axapi/v3/aam/authentication/captcha Payload: { "captcha": { "instance-list": [ { "name": "a", "secret-key": 1, "secret-key-string": "a" } ] } }
Get Object	GET	/axapi/v3/aam/authentication/captcha	captcha attributes
GET /axapi/v3/aam/authentication/captcha Reponse: { "captcha": { "uuid": "db2024a0-6612-11d9-9a27-692335d4f00d", "instance-list": [ { "name": "a", "secret-key": 1, "encrypted": "EJRvLhC/EB+MSclPaNmfSPA/tWktPFJbz5GtCYzuMsQh4bTHOIX5HsV8FbKTcEAw", "method": "POST", "timeout": 10, "send-client-ip": 0, "uuid": "d19b2ac4-4f50-11ee-bde4-3768133b9b1a", "a10-url": "/axapi/v3/aam/authentication/captcha/instance/a" } ], "a10-url": "/axapi/v3/aam/authentication/captcha" } }
Modify Object	POST	/axapi/v3/aam/authentication/captcha	captcha attributes
Replace Object	PUT	/axapi/v3/aam/authentication/captcha	captcha attributes
Delete Object	DELETE	/axapi/v3/aam/authentication/captcha	captcha attributes
DELETE /axapi/v3/aam/authentication/captcha Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

captcha attributes¶

instance-list

Type: List

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

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