External Application Settings - Online Help

External Application Settings

Use this dialog box to register an application if you are connecting to the CommVault Web Console from an outside portal and want to use external authentication. For more information, see External Authentication with Third-Party Integration - Web Console or External Authentication with SAML - Web Console.

The following information is displayed:

  • Application key

    The application key assigned to the application.

  • Application name

    The user-defined name of the application.

  • Enabled

    If the check box is selected, the application is enabled. If the check box is cleared, the application is disabled.

  • Description

    The user-defined description of the application.

Add

Click to add a new application. For information on the dialog box used to add new applications, see Add/Edit/View Application info.

View

Click to view the application and the application key, token, and secret associated with it.

Edit

Click to edit an application. For information on the dialog box used to edit applications, see Add/Edit/View Application info.

The application token and application secret cannot be manually edited. For information on creating a new application token and application secret, see Renew.

Renew (Available when Application Type equals Regular)

Click to create a new application token and application secret for the application.

The program used to form the encrypted JSON message and to send the message to the Web Console must use the new application token and application secret.

For more information, see External Authentication with Third-Party Integration - Web Console.

Delete

Click to delete the application and the application key, token, and secret associated with it.

Add/Edit/View Application info (General)

Use these dialog boxes to add an application or to edit or view application information. These dialog boxes open when Add, View, or Edit is clicked from the External Application Setting dialog box. For information on the External Application Setting dialog box, see External Application Settings.

Application name

The user-defined name of the application.

Application Type

The type of application used for external authentication.

Application key (Not available in the "Add" dialog box)

The application key assigned to the application.

Enabled

If the check box is selected, the application is enabled. If the check box is cleared, the application is disabled.

Description

The user-defined description of the application.

Add/Edit/View Application info

Third Party (Edit and View)

The information in this tab is read-only. To generate a new application token and application secret, use the Renew button in the External Application Settings dialog box.

Application token

The application token assigned to the application.

Application secret

The application secret assigned to the application.

SAML

Use this tab to add provider metadata for use with SAML authentication. This tab is available when SAML is selected from the Application Type box.

Enable Signature verification

Select this option if the Service Provider (SP) should sign the request message before sending it to the Identity Provider (IdP).

Upload IDP Metadata

  • File Path

    The location and file name of the XML file that contains the Identity Provider (IdP) metadata.

  • Entity ID

    A unique ID for the Identity Provider (IdP). This information is uploaded from the IdP metadata file.

  • Redirect Url

    One method the Service Provider (SP) can use to send the initial SAML authentication request to the Identity Provider (IdP). The request information is encoded and sent as part of the URL. This information is uploaded from the IdP metadata file.

  • Post Url

    One method the Service Provider (SP) can use to send the initial SAML authentication request to the Identity Provider (IdP). The request information is sent as an HTML form to this URL. This information is uploaded from the IdP metadata file.

Reuse\Generate SP metadata

  • Use submitted metadata

    This option is available if Service Provider (SP) metadata exists. Select this option to keep the existing SP metadata when you update the Identity Provider (IdP) metadata.

  • Generate new metadata

    Select this option to generate Service Provider (SP) metadata or to replace existing SP metadata.

  • File Path

    The location and file name of the key store file.

  • Web Console

    The Web Console to use with SAML authentication.

  • Alias Name

    The alias name used in the key store file.

  • Key store password

    The key store password used for the key store file.

  • Key password

    The key password used in the key store file.

  • Destination file path

    The location and file name for the Service Provider (SP) metadata XML file. The XML is created once OK is clicked.

View Certificate

Click to view the Service Provider (SP) certificate. Before clicking View certificate, the certificate file path, alias name, key store password, and key password must be entered.

View certificate

Certificate Data

The encoded Service Provider (SP) certificate.