Update Web-tier Authentication Configuration

Description

The updateWebAuthConfig resource adds, updates, or removes the web-tier authentication credentials or certificate used to communicate with another participant in the collaboration. This participant is identified by the participant-id in the URL.

Request parameters

Parameter

Details

webAuthUsername

The username for the web-tier authentication. This can be in the format domain/username or just username.

webAuthPassword

The corresponding password for the username.

webAuthCertificateFile

The PKI certificate file used for client certificate authentication. This file needs to be in PKCS12 format.

webAuthCertPassword

The corresponding password for the PKI certificate file. If no password is required, this field can be left empty.

clearWebAuthConfig

Value must be true or false. If true, this will clear all web-tier authentication credentials or certificates stored for the participant portal. This value is false by default.

Response parameters

Parameter

Details

success

This value will either be true or false.

collaborationID

The ID of the collaboration for which the web-tier authentication credentials were changed.

portalID

The ID of the participant whose web-tier authentication credentials were changed.

12/1/2017