aam authentication saml

Configure Security Assertion Markup Language (SAML) related settings.

saml Specification

Type Intermediate Resource
Element Name saml
Element URI /axapi/v3/aam/authentication/saml
Element Attributes saml_attributes
Schema saml schema

Operations Allowed:

Operation Method URI Payload

Get Object

GET

/axapi/v3/aam/authentication/saml

saml_attributes

saml Attributes

global

Description: global is a JSON Block . Please see below for global

Type: Object

Reference Object: /axapi/v3/aam/authentication/saml/global

identity-provider-list

Description: identity-provider-list is a JSON List . Please see below for identity-provider-list

Type: List

Reference Object: /axapi/v3/aam/authentication/saml/identity-provider/{name}

service-provider-list

Description: service-provider-list is a JSON List . Please see below for service-provider-list

Type: List

Reference Object: /axapi/v3/aam/authentication/saml/service-provider/{name}

global

Specification
Type object

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l1076_sampling-enable

Type: List

uuid

Description: uuid of the object

Type: string

global.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘requests-to-a10saml’: Total Request to A10 SAML Service; ‘responses-from-a10saml’: Total Response from A10 SAML Service; ‘sp-metadata-export-req’: Total Metadata Export Request; ‘sp-metadata-export-success’: Toal Metadata Export Success; ‘login-auth-req’: Total Login Authentication Request; ‘login-auth-resp’: Total Login Authentication Response; ‘acs-req’: Total SAML Single-Sign-On Request; ‘acs-success’: Total SAML Single-Sign-On Success; ‘acs-authz-fail’: Total SAML Single-Sign-On Authorization Fail; ‘acs-error’: Total SAML Single-Sign-On Error; ‘slo-req’: Total Single Logout Request; ‘slo-success’: Total Single Logout Success; ‘slo-error’: Total Single Logout Error; ‘other-error’: Total Other Error;

Type: string

Supported Values: all, requests-to-a10saml, responses-from-a10saml, sp-metadata-export-req, sp-metadata-export-success, login-auth-req, login-auth-resp, acs-req, acs-success, acs-authz-fail, acs-error, slo-req, slo-success, slo-error, other-error

service-provider-list

Specification
Type list
Block object keys

adfs-ws-federation

Description: adfs-ws-federation is a JSON Block . Please see below for l1076_adfs-ws-federation

Type: Object

artifact-resolution-service

Description: artifact-resolution-service is a JSON List . Please see below for l1076_artifact-resolution-service

Type: List

assertion-consuming-service

Description: assertion-consuming-service is a JSON List . Please see below for l1076_assertion-consuming-service

Type: List

certificate

Description: SAML service provider certificate file (PFX format is required.)

Type: string

entity-id

Description: SAML service provider entity ID

Type: string

Format: string-rlx

metadata-export-service

Description: metadata-export-service is a JSON Block . Please see below for l1076_metadata-export-service

Type: Object

name

Description: Specify SAML authentication service provider name

Type: string

require-assertion-signed

Description: require-assertion-signed is a JSON Block . Please see below for l1076_require-assertion-signed

Type: Object

saml-request-signed

Description: saml-request-signed is a JSON Block . Please see below for l1076_saml-request-signed

Type: Object

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l1076_sampling-enable

Type: List

service-url

Description: SAML service provider service URL (ex. https://www.a10networks.com/saml.sso )

Type: string

Format: string-rlx

single-logout-service

Description: single-logout-service is a JSON List . Please see below for l1076_single-logout-service

Type: List

soap-tls-certificate-validate

Description: soap-tls-certificate-validate is a JSON Block . Please see below for l1076_soap-tls-certificate-validate

Type: Object

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

service-provider-list.require-assertion-signed

Specification
Type object

require-assertion-signed-enable

Description: Enable required signing of SAML assertion

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

service-provider-list.single-logout-service

Specification
Type list
Block object keys

SLO-binding

Description: ‘post’: POST binding of single logout service; ‘redirect’: Redirect binding of single logout service; ‘soap’: SOAP binding of single logout service;

Type: string

Supported Values: post, redirect, soap

SLO-location

Description: The location of name-id management service. (ex. /SAML/POST)

Type: string

Format: string-rlx

service-provider-list.assertion-consuming-service

Specification
Type list
Block object keys

assertion-binding

Description: ‘artifact’: Artifact binding of assertion consuming service; ‘paos’: PAOS binding of assertion consuming service; ‘post’: POST binding of assertion consuming service;

Type: string

Supported Values: artifact, paos, post

assertion-index

Description: The index of assertion consuming service

Type: number

Range: 0-5

assertion-location

Description: The location of assertion consuming service endpoint. (ex. /SAML/POST)

Type: string

Format: string-rlx

service-provider-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘sp-metadata-export-req’: Metadata Export Request; ‘sp-metadata-export-success’: Metadata Export Success; ‘login-auth-req’: Login Authentication Request; ‘login-auth-resp’: Login Authentication Response; ‘acs-req’: SAML Single-Sign-On Request; ‘acs-success’: SAML Single-Sign-On Success; ‘acs-authz-fail’: SAML Single-Sign-On Authorization Fail; ‘acs-error’: SAML Single-Sign-On Error; ‘slo-req’: Single Logout Request; ‘slo-success’: Single Logout Success; ‘slo-error’: Single Logout Error; ‘other-error’: Other Error;

Type: string

Supported Values: all, sp-metadata-export-req, sp-metadata-export-success, login-auth-req, login-auth-resp, acs-req, acs-success, acs-authz-fail, acs-error, slo-req, slo-success, slo-error, other-error

service-provider-list.saml-request-signed

Specification
Type object

saml-request-signed-disable

Description: Disable signing signature for SAML (Authn/Artifact Resolve) requests

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

service-provider-list.adfs-ws-federation

Specification
Type object

ws-federation-enable

Description: Enable ADFS WS-Federation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

service-provider-list.soap-tls-certificate-validate

Specification
Type object

soap-tls-certificate-validate-disable

Description: Disable verification for server certificate in TLS session when resolving artificate

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

service-provider-list.artifact-resolution-service

Specification
Type list
Block object keys

artifact-binding

Description: ‘soap’: SOAP binding of artifact resolution service;

Type: string

Supported Values: soap

artifact-index

Description: The index of artifact resolution service

Type: number

Range: 0-5

artifact-location

Description: The location of artifact resolution service. (ex. /SAML/POST)

Type: string

Format: string-rlx

service-provider-list.metadata-export-service

Specification
Type object

md-export-location

Description: Specify the URI to export SP metadata (Export URI. Default is /A10SP_Metadata)

Type: string

Format: string-rlx

sign-xml

Description: Sign exported SP metadata XML with SP’s certificate

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

identity-provider-list

Specification
Type list
Block object keys

metadata

Description: URL of SAML identity provider’s metadata file

Type: string

Format: string-rlx

name

Description: SAML authentication identity provider name

Type: string

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string