aam jwt-authorization¶
AAM JWT authorization related configuration
jwt-authorization Specification¶
Type
Collection
Object Key(s)
name
Collection Name
Collection URI
/axapi/v3/aam/jwt-authorization
Element Name
jwt-authorization
Element URI
/axapi/v3/aam/jwt-authorization/{name}
Element Attributes
jwt-authorization_attributes
Statistics Data URI
/axapi/v3/aam/jwt-authorization/{name}/stats
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/aam/jwt-authorization | ||
Create List | POST | /axapi/v3/aam/jwt-authorization | ||
Get Object | GET | /axapi/v3/aam/jwt-authorization/{name} | ||
Get List | GET | /axapi/v3/aam/jwt-authorization | ||
Modify Object | POST | /axapi/v3/aam/jwt-authorization/{name} | ||
Replace Object | PUT | /axapi/v3/aam/jwt-authorization/{name} | ||
Replace List | PUT | /axapi/v3/aam/jwt-authorization | ||
Delete Object | DELETE | /axapi/v3/aam/jwt-authorization/{name} |
jwt-authorization-list¶
jwt-authorization-list is JSON List of jwt-authorization attributes
jwt-authorization-list : [
]
jwt-authorization attributes¶
encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)
exp-claim-requried
Description Specify the exp claim is required for JWT authorization
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
jwt-cache-enable
Description Enable caching authorized JWT token and skip verification and authorization for cached tokens
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
jwt-exp-default
Description Specify the default token expiration if exp claim is not available (default 1800)
Type: number
Range: 1-86400
jwt-forwarding
Description Specify JWT token will not be stripped while forwarding client request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
log-level
Description ‘0’: log disable; ‘1’: only log authorzation fail (default); ‘2’: only log authorization success; ‘3’: log all;
Type: string
Supported Values: 0, 1, 2, 3
name
Description Specify JWT authorization template 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
verification-cert
Description Specify the certificate to verify JWT token signature
Type: string
Maximum Length: 255 characters
Maximum Length: 1 characters
Mutual Exclusion: verification-cert verification-jwks and verification-secret are mutually exclusive
verification-jwks
Description Specify the jwks file to verify JWT token signature
Type: string
Maximum Length: 255 characters
Maximum Length: 1 characters
Mutual Exclusion: verification-jwks verification-cert and verification-secret are mutually exclusive
verification-secret
Description Specify secret for verify JWT token signature
Type: string
Format: password
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: verification-secret verification-cert and verification-jwks are mutually exclusive
stats data¶
Counter |
Size |
Description |
|
|---|---|---|---|
jwt-request |
8 |
JWT Request |
|
jwt-authorize-success |
8 |
JWT Authorize Success |
|
jwt-token-expired |
8 |
JWT Token Expired |
|
jwt-authorize-failure |
8 |
JWT Authorize Failure |
|
jwt-missing-claim |
8 |
JWT Missing Claim |
|
jwt-signature-failure |
8 |
JWT Signature Failure |
|
jwt-other-error |
8 |
JWT Other Error |
|
jwt-missing-token |
8 |
JWT Missing Token |