aam authentication saml metadata-monitor¶

Configure SAML metadata out-of-sync detection and recovery options

metadata-monitor Specification¶

Parameter Value

Type Configuration Resource

Element Name metadata-monitor

Element URI /axapi/v3/aam/authentication/saml/metadata-monitor

Element Attributes metadata-monitor_attributes

Partition Visibility shared

Schema metadata-monitor schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/aam/authentication/saml/metadata-monitor	metadata-monitor attributes
POST /axapi/v3/aam/authentication/saml/metadata-monitor Payload: { "metadata-monitor": { "status": "enable" } }
Get Object	GET	/axapi/v3/aam/authentication/saml/metadata-monitor	metadata-monitor attributes
GET /axapi/v3/aam/authentication/saml/metadata-monitor Reponse: { "metadata-monitor": { "status": "enable", "uuid": "2832f30a-4f59-11ee-bde4-3768133b9b1a", "a10-url": "/axapi/v3/aam/authentication/saml/metadata-monitor" } }
Modify Object	POST	/axapi/v3/aam/authentication/saml/metadata-monitor	metadata-monitor attributes
Replace Object	PUT	/axapi/v3/aam/authentication/saml/metadata-monitor	metadata-monitor attributes
PUT /axapi/v3/aam/authentication/saml/metadata-monitor Payload: { "metadata-monitor": { "acs-continuous-fail-threshold": 3 } }
Delete Object	DELETE	/axapi/v3/aam/authentication/saml/metadata-monitor	metadata-monitor attributes
DELETE /axapi/v3/aam/authentication/saml/metadata-monitor Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

metadata-monitor attributes¶

acs-continuous-fail-threshold

Description Specify how many ACS continuous fails will trigger metadata reload (ACS continuous fail threshold (default: 10))

Type: number

Range: 2-254

acs-missing-period

Description Specify how long no acs request will trigger metadata reload (in seconds (default: 60))

Type: number

Range: 1-254

acs-missing-threshold

Description Specify how many ACS request missing in the period will trigger metadata reload (ACS request missing threshold (default: 100))

Type: number

Range: 10-254

status

Description ‘enable’: Enable SAML metadata out-of-sync detection; ‘disable’: Disable SAML metadata out-of-sync detection;

Type: string

Supported Values: enable, disable

Default: enable

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters