aam authentication oauth authorization-server¶

Authentication 2.0 authorization server

authorization-server Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name authorization-server-list

Collection URI /axapi/v3/aam/authentication/oauth/authorization-server

Element Name authorization-server

Element URI /axapi/v3/aam/authentication/oauth/authorization-server/{name}

Element Attributes authorization-server_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/aam/authentication/oauth/authorization-server/{name}/stats

Schema authorization-server schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/aam/authentication/oauth/authorization-server	authorization-server attributes
Create List	POST	/axapi/v3/aam/authentication/oauth/authorization-server	authorization-server attributes
Get Object	GET	/axapi/v3/aam/authentication/oauth/authorization-server/{name}	authorization-server attributes
Get List	GET	/axapi/v3/aam/authentication/oauth/authorization-server	authorization-server-list
Modify Object	POST	/axapi/v3/aam/authentication/oauth/authorization-server/{name}	authorization-server attributes
Replace Object	PUT	/axapi/v3/aam/authentication/oauth/authorization-server/{name}	authorization-server attributes
Replace List	PUT	/axapi/v3/aam/authentication/oauth/authorization-server	authorization-server-list
Delete Object	DELETE	/axapi/v3/aam/authentication/oauth/authorization-server/{name}	authorization-server attributes

authorization-server-list¶

authorization-server-list is JSON List of authorization-server attributes

authorization-server-list : [

{ authorization-server attributes },

{ authorization-server attributes },

…

]

authorization-server attributes¶

authorization-endpoint

Description Specify URI for authorization

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

client-method

Description ‘ignored’: Clients’ browser will send data according to server spec (default); ‘post’: Clients’ browser will send data by POST; ‘get’: Clients’ browser will send data by GET;

Type: string

Supported Values: ignored, post, get

issuer

Description Specify openid provider name for authorization

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

name

Description Specify authorization server object name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

sampling-enable

Type: List

server-method

Description ‘post’: AX will send data to server by POST (default); ‘get’: AX will send data to server by GET;

Type: string

Supported Values: post, get

token-endpoint

Description Specify URI for token exchange

Type: string

Format: string-rlx

Maximum Length: 127 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 certificate to verify ID token signature

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: verification-cert and verification-jwks are mutually exclusive

verification-jwks

Description Specify jwks file to verify ID token signature

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: verification-jwks and verification-cert are mutually exclusive

sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘auth-req’: some help string; ‘auth-succ’: some help string; ‘auth-fail’: some help string; ‘auth-error’: some help string; ‘other-error’: some help string;

Type: string

Supported Values: all, auth-req, auth-succ, auth-fail, auth-error, other-error