ValidateCollaborationInvitation

Description

The validateCollaborationInvitation resource allows a portal to validate a collaboration invitation. The invitation file received securely from the collaboration host portal must be provided. Validation checks include checking that the invitation is for the intended recipient.

Request parameters

Parameter

Details

invitationFile

A multipart form parameter—file upload. Use either this parameter or invitationJSON.

invitationJSON

The same contents as the invitationFile parameter but passed as a string. Use either this parameter or invitationFile.

guestContactFirstname

The first name of the contact person for the guest portal.

guestContactLastname

The last name of the contact person for the guest portal.

guestContactEmailAddress

The email address for the contact person for the guest portal.

hostWebauthUsername

If the collaboration host requires web-tier authentication, optionally use this parameter to provide the host's web-tier authentication user name.

hostWebauthPassword

If the collaboration host requires web-tier authentication, optionally use this parameter to provide the host's web-tier authentication password.

hostWebauthCertificateFile

If the collaboration host requires web-tier authentication, optionally use this parameter to provide the host's web-tier authentication certificate file.

hostWebauthCertPassword

If the collaboration host requires web-tier authentication, optionally use this parameter to provide the host's web-tier authentication certificate password.

Response properties

Property

Details

success

Indicates whether the collaboration invitation was successfully validated. Returns true if so.

7/5/2017