aam authentication saml service-provider

Configure profile and specifications for the service provider within Security Assertion Markup Language (SAML) for authentication.

service-provider Specification

Type Collection
Object Key(s) name
Collection Name service-provider-list
Collection URI /axapi/v3/aam/authentication/saml/service-provider/
Element Name service-provider
Element URI /axapi/v3/aam/authentication/saml/service-provider/{name}
Element Attributes service-provider_attributes
Statistics Data URI /axapi/v3/aam/authentication/saml/service-provider/{name}/stats
Schema service-provider schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/aam/authentication/saml/service-provider/

service-provider Attributes

Create List

POST

/axapi/v3/aam/authentication/saml/service-provider/

service-provider Attributes

Get Object

GET

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

service-provider Attributes

Get List

GET

/axapi/v3/aam/authentication/saml/service-provider/

service-provider-list

Modify Object

POST

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

service-provider Attributes

Replace Object

PUT

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

service-provider Attributes

Replace List

PUT

/axapi/v3/aam/authentication/saml/service-provider/

service-provider-list

Delete Object

DELETE

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

service-provider Attributes

Get Stats

GET

/axapi/v3/aam/authentication/saml/service-provider/{name}/stats

stats data

service-provider-list

service-provider-list is JSON List of service-provider Attributes

service-provider-list : [

service-provider Attributes

adfs-ws-federation

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

Type: Object

artifact-resolution-service

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

Type: List

assertion-consuming-service

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

Type: List

certificate

Description: The SAML service provider certificate file.

Type: string

entity-id

Description: The 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 metadata-export-service

Type: Object

name

Description: SAML authentication service provider’s name.

Type: string

Required: Yes

require-assertion-signed

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

Type: Object

saml-request-signed

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

Type: Object

sampling-enable

Description: sampling-enable is a JSON List . Please see below for 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 single-logout-service

Type: List

soap-tls-certificate-validate

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

Type: Object

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

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

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

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

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

saml-request-signed

Specification
Type object

saml-request-signed-disable

Description: Signing SAML requests (AuthnRequest or Artifact Resolve).

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

adfs-ws-federation

Specification
Type object

ws-federation-enable

Description: Enable ADFS WS-Federation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

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

metadata-export-service

Specification
Type object

md-export-location

Description: Specify the URI of the SAML metadata export service. The default location is /A10SP_Metadata.

Type: string

Format: string-rlx

sign-xml

Description: The sign-xml option signs the exported service provider metadata XML with service provider’s certificate.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

stats data

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