aam authentication jwt¶

JWT issuance configuration

jwt Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name jwt-list

Collection URI /axapi/v3/aam/authentication/jwt

Element Name jwt

Element URI /axapi/v3/aam/authentication/jwt/{name}

Element Attributes jwt_attributes

Partition Visibility shared

Schema jwt schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/aam/authentication/jwt	jwt attributes
POST /axapi/v3/aam/authentication/jwt/ Payload: { "jwt": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/aam/authentication/jwt	jwt attributes
Get Object	GET	/axapi/v3/aam/authentication/jwt/{name}	jwt attributes
GET /axapi/v3/aam/authentication/jwt/a Reponse: { "jwt": { "name": "a", "token-lifetime": 300, "signature-secret": 0, "uuid": "7dd0eed2-4f51-11ee-bde4-3768133b9b1a", "user-tag": "a", "a10-url": "/axapi/v3/aam/authentication/jwt/a" } }
Get List	GET	/axapi/v3/aam/authentication/jwt	jwt-list
Modify Object	POST	/axapi/v3/aam/authentication/jwt/{name}	jwt attributes
Replace Object	PUT	/axapi/v3/aam/authentication/jwt/{name}	jwt attributes
PUT /axapi/v3/aam/authentication/jwt/a Payload: { "jwt": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/aam/authentication/jwt	jwt-list
Delete Object	DELETE	/axapi/v3/aam/authentication/jwt/{name}	jwt attributes
DELETE /axapi/v3/aam/authentication/jwt/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

jwt-list¶

jwt-list is JSON List of jwt attributes

jwt-list : [

{ jwt attributes },

{ jwt attributes },

…

]

jwt attributes¶

action

Description ‘redirect’: redirect JWT to specific URI; ‘relay’: relay JWT to back-end;

Type: string

Supported Values: redirect, relay

encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

issuer

Description Specify JWT issuer claim value

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

jwt-relay-uri

Description Specify JWT relay URI (for relay action)

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

name

Description Specify JWT issuer template name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

secret-string

Description The JWT signature secret

Type: string

Format: password

Maximum Length: 128 characters

Maximum Length: 1 characters

signature-secret

Description Specify the JWT signature secret

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

token-lifetime

Description Specify JWT token lifetime (Specify lifetime (in seconds), default is 300.)

Type: number

Range: 0-86400

Default: 300

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