aam authentication oauth client

Authentication 2.0 Oauth client

client Specification

   
Type Collection
Object Key(s) name
Collection Name client-list
Collection URI /axapi/v3/aam/authentication/oauth/client
Element Name client
Element URI /axapi/v3/aam/authentication/oauth/client/{name}
Element Attributes client_attributes
Schema client schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/aam/authentication/oauth/client

client attributes

Create List

POST

/axapi/v3/aam/authentication/oauth/client

client attributes

Get Object

GET

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

client attributes

Get List

GET

/axapi/v3/aam/authentication/oauth/client

client-list

Modify Object

POST

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

client attributes

Replace Object

PUT

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

client attributes

Replace List

PUT

/axapi/v3/aam/authentication/oauth/client

client-list

Delete Object

DELETE

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

client attributes

client-list

client-list is JSON List of client attributes

client-list : [

client attributes

client-id

Description Specify oauth client-id

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

client-secret

Description

Type: string

Format: password

Maximum Length: 127 characters

Maximum Length: 1 characters

encrypted

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

grant-type

Description ‘implicit’: The authorization server will return access token directly.; ‘authorization-code’: The authorization server will respond with code which can be exchange for access token.; ‘hybrid-code-id-token’: The authorization server will respond with both code and id token.; ‘hybrid-code-token’: The authorization server will respond with both code and access token.; ‘hybrid-all’: The authorization server will respond with code, access token and id token;

Type: string

Supported Values: implicit, authorization-code, hybrid-code-id-token, hybrid-code-token, hybrid-all

infinity

Description Auth session never time out whatever value oauth servers’ response

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: infinity and token-lifetime are mutually exclusive

name

Description Specify client object name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

no-reply

Description AX will not check the nonce value in response

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

parameter-nonce-enable

Description Enable nonce parameter for authorization and token request

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

redirection-endpoint

Description Oauth client redirection endpoint service URL.

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

scope

Description Specify request scope parameters (e.g. profile email address phone)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

session-init-ttl

Description TTL for Thunder to wait for first response from authorization server

Type: number

Range: 1-60

token-lifetime

Description

Type: number

Range: 1-2592000

Mutual Exclusion: token-lifetime and infinity are mutually exclusive

type

Description ‘openid-connect’: openid-connect;

Type: string

Supported Values: openid-connect

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