aam authentication relay saml

SAML Authentication Relay

saml Specification

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

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/aam/authentication/relay/saml

saml attributes

Create List

POST

/axapi/v3/aam/authentication/relay/saml

saml attributes

Get Object

GET

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

saml attributes

Get List

GET

/axapi/v3/aam/authentication/relay/saml

saml-list

Modify Object

POST

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

saml attributes

Replace Object

PUT

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

saml attributes

Replace List

PUT

/axapi/v3/aam/authentication/relay/saml

saml-list

Delete Object

DELETE

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

saml attributes

saml-list

saml-list is JSON List of saml attributes

saml-list : [

saml attributes

idp-auth-uri

Description Specify the URI for IDP to handle SAML authentication request

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

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

match-uri

Description Match URI

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

method

Description ‘get-from-backend’: Get RelayState parameter from backend server; ‘request-uri’: Use the (URL encoded) current request-uri as the RelayState;

Type: string

Supported Values: get-from-backend, request-uri

Mutual Exclusion: method and value are mutually exclusive

name

Description Specify SAML authentication relay name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

relay-acs-uri

Description Specify the backend server assertion consuming service URI

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

retry-number

Description Specify how many continuous fail for SAML relay will trigger. Default will not retry.

Type: number

Range: 0-10

Default: 0

sampling-enable

Type: List

server-cookie-name

Description Specify the cookie name that used by backend server for authenticated users

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

value

Description Use the fixed string as the RelayState

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: value and method are mutually exclusive

sampling-enable

Specification Value
Type list
Block object keys  

counters1

Description ‘all’: all; ‘request’: Request; ‘success’: Success; ‘failure’: Failure; ‘error’: Error;

Type: string

Supported Values: all, request, success, failure, error