aam authentication saml identity-provider¶

Authentication identity provider

identity-provider Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name identity-provider-list

Collection URI /axapi/v3/aam/authentication/saml/identity-provider

Element Name identity-provider

Element URI /axapi/v3/aam/authentication/saml/identity-provider/{name}

Element Attributes identity-provider_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/aam/authentication/saml/identity-provider/{name}/stats

Operational Data URI /axapi/v3/aam/authentication/saml/identity-provider/{name}/oper

Schema identity-provider schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/aam/authentication/saml/identity-provider	identity-provider attributes
POST /axapi/v3/aam/authentication/saml/identity-provider/ Payload: { "identity-provider": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/aam/authentication/saml/identity-provider	identity-provider attributes
Get Object	GET	/axapi/v3/aam/authentication/saml/identity-provider/{name}	identity-provider attributes
GET /axapi/v3/aam/authentication/saml/identity-provider/a Reponse: { "identity-provider": { "name": "a", "reload-interval": 28800, "uuid": "efa613f0-4f58-11ee-bde4-3768133b9b1a", "user-tag": "a", "a10-url": "/axapi/v3/aam/authentication/saml/identity-provider/a" } }
Get List	GET	/axapi/v3/aam/authentication/saml/identity-provider	identity-provider-list
Modify Object	POST	/axapi/v3/aam/authentication/saml/identity-provider/{name}	identity-provider attributes
Replace Object	PUT	/axapi/v3/aam/authentication/saml/identity-provider/{name}	identity-provider attributes
PUT /axapi/v3/aam/authentication/saml/identity-provider/a Payload: { "identity-provider": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/aam/authentication/saml/identity-provider	identity-provider-list
Delete Object	DELETE	/axapi/v3/aam/authentication/saml/identity-provider/{name}	identity-provider attributes
DELETE /axapi/v3/aam/authentication/saml/identity-provider/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

identity-provider-list¶

identity-provider-list is JSON List of identity-provider attributes

identity-provider-list : [

{ identity-provider attributes },

{ identity-provider attributes },

…

]

identity-provider attributes¶

metadata

Description URL of SAML identity provider’s metadata file

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

name

Description SAML authentication identity provider name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

reload-interval

Description Specify URI metadata reload period (Specify URI metadata reload period in seconds, default is 28800)

Type: number

Range: 1-86400

Default: 28800

reload-metadata

Description Reload IdP’s metadata immediately

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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