Skip To Content
ArcGIS Developers
Dashboard

/acceptCollaborationInvitation: Accept Invitation

  • URL:https://[root]/portals/[portalID]/acceptCollaborationInvitation(POST only)
  • Required Capability:Administrator (guest)
  • Version Introduced:10.5

Example usage

Below is a sample ArcGIS Enterprise multipart POST request for the acceptCollaborationInvitation operation:

POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/acceptCollaborationInvitation HTTP/1.1
Host: machine.domain.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary2GBVvqDqPuRWXT4N
Content-Length: []

------WebKitFormBoundary2GBVvqDqPuRWXT4N
Content-Disposition: form-data; name="invitationFile"; filename=""
Content-Type: application/octet-stream

collaboration-org.domain.com.invite
------WebKitFormBoundary2GBVvqDqPuRWXT4N
Content-Disposition: form-data; name="guestContactFirstname"

John
------WebKitFormBoundary2GBVvqDqPuRWXT4N
Content-Disposition: form-data; name="guestContactLastname"

Smith
------WebKitFormBoundary2GBVvqDqPuRWXT4N
Content-Disposition: form-data; name="guestContactEmailAddress"

JSmith@org.com
------WebKitFormBoundary2GBVvqDqPuRWXT4N
Content-Disposition: form-data; name="hostWebauthUsername"


------WebKitFormBoundary2GBVvqDqPuRWXT4N
Content-Disposition: form-data; name="hostWebauthPassword"


------WebKitFormBoundary2GBVvqDqPuRWXT4N
Content-Disposition: form-data; name="hostWebauthCertificateFile"; filename=""
Content-Type: application/octet-stream


------WebKitFormBoundary2GBVvqDqPuRWXT4N
Content-Disposition: form-data; name="hostWebauthCertPassword"


------WebKitFormBoundary2GBVvqDqPuRWXT4N
Content-Disposition: form-data; name="f"

pjson
------WebKitFormBoundary2GBVvqDqPuRWXT4N--

Description

The acceptCollaborationInvitation operation allows an ArcGIS Enterprise organization to accept a collaboration invitation. The invitation file received securely from the collaboration host must be provided as input for the invitationFile parameter. Once a guest accepts an invitation to a collaboration, they must link workspaces associated with the collaboration to local organization groups. The guest must export a collaboration invitation response file and send it to the host. Once the host processes the response, content can be shared between the host and participating guests.

Note:

This operation is only available for ArcGIS Enterprise organizations. ArcGIS Online does not support participating in a collaboration as a guest. ArcGIS Online organizations must participate as the collaboration host.

Request parameters

ParameterDetails
invitationFile

A multipart form parameter—file upload.

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.

f

The response format. The default format is html.

Values: html | json | pjson

JSON Response example

{"success": true}