Skip to main content

security saml-sp modify

Contributors
Suggest changes
PDFs

Modify SAML service provider authentication

Availability: This command is available to cluster administrators at the admin privilege level.

Description

The security saml-sp modify command modifies the Security Assertion Markup Language (SAML) Service Provider (SP) configuration for single sign-on authentication. This command is used to enable or disable an existing SAML SP, security saml-sp modify-is-enabled`true or false` respectively.

This command will check the validity of the current SAML SP configuration before enabling the SP. Also, it is necessary to use this command with the -is-enabled`false parameter prior to deleting an existing SAML SP configuration. SAML SP can only be disabled in this way by a password authenticated console application user or from a SAML authenticated command interface. The delete command must be used if the SAML configuration settings are to be changed, as only the `is-enabled parameter can be modified.

Note This may restart the web server. Any HTTP/S connections that are active may be disrupted.

Parameters

[-is-enabled {true|false}] - SAML Service Provider Enabled

Use this parameter to enable or disable the SAML SP.

Examples

The following example enables SAML SP:

cluster1::> security saml-sp modify -is-enabled true
    cluster1::>