aam authentication relay oauth

Oauth 2.0 Authentication Relay

oauth Specification

Parameter Value
Type Collection
Object Key(s) name
Collection Name oauth-list
Collection URI /axapi/v3/aam/authentication/relay/oauth
Element Name oauth
Element URI /axapi/v3/aam/authentication/relay/oauth/{name}
Element Attributes oauth_attributes
Partition Visibility shared
Statistics Data URI /axapi/v3/aam/authentication/relay/oauth/{name}/stats
Schema oauth schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/aam/authentication/relay/oauth

oauth attributes

Create List

POST

/axapi/v3/aam/authentication/relay/oauth

oauth attributes

Get Object

GET

/axapi/v3/aam/authentication/relay/oauth/{name}

oauth attributes

Get List

GET

/axapi/v3/aam/authentication/relay/oauth

oauth-list

Modify Object

POST

/axapi/v3/aam/authentication/relay/oauth/{name}

oauth attributes

Replace Object

PUT

/axapi/v3/aam/authentication/relay/oauth/{name}

oauth attributes

Replace List

PUT

/axapi/v3/aam/authentication/relay/oauth

oauth-list

Delete Object

DELETE

/axapi/v3/aam/authentication/relay/oauth/{name}

oauth attributes

oauth-list

oauth-list is JSON List of oauth attributes

oauth-list : [

oauth attributes

all

Description All URI can be relay

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: all and match-type are mutually exclusive

match-type

Description ‘equals’: URI exactly matches the string; ‘contains’: URI string contains another sub string; ‘starts-with’: URI string starts with sub string; ‘ends-with’: URI string ends with sub string;

Type: string

Supported Values: equals, contains, starts-with, ends-with

Mutual Exclusion: match-type and all are mutually exclusive

match-uri

Description

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

name

Description Specify oauth authentication relay name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

relay-type

Description ‘access-token’: Relay access token to backend; ‘id-token’: Relay JWT to backend;

Type: string

Supported Values: access-token, id-token

sampling-enable

Type: List

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

sampling-enable

Specification Value
Type list
Block object keys  

counters1

Description ‘all’: all; ‘relay-req’: some help string; ‘relay-succ’: some help string; ‘relay-fail’: some help string;

Type: string

Supported Values: all, relay-req, relay-succ, relay-fail