Skip To Content
ArcGIS Developers
Dashboard

/inviteParticipant: Invite Participant

  • URL:https://[root]/portals/[portalID]/collaborations/[collaborationID]/inviteParticipant(POST only)
  • Required Capability:Administrator (host)
  • Version Introduced:10.5

Example usage

Below is a sample ArcGIS Online POST request for the inviteParticipant operation:

POST /sharing/rest/portals/0123456789ABCDEF/collaborations/eefa7ebb30aa435382cc9b27ffa95e3e/inviteParticipant HTTP/1.1
Host: org.arcgis.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

guestPortalUrl=https://addmachine.org.com/webadaptor&collaborationWorkspacesParticipantConfigJSON=[{"027e51c925584f2ba06729fa2ab4497f": "send"}]&expiration=24&f=pjson

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

POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/collaborations/eefa7ebb30aa435382cc9b27ffa95e3e/inviteParticipant HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

guestPortalUrl=https://addmachine.org.com/webadaptor&collaborationWorkspacesParticipantConfigJSON=[{"027e51c925584f2ba06729fa2ab4497f": "send"}]&expiration=24&f=pjson

Description

As a collaboration host, once you have set up a new collaboration, you are ready to invite other portals as participants in your collaboration. The inviteParticipant operation allows you to invite other portals to your collaboration by creating an invitation file. You need to send this invitation file to the administrator of the portal you are inviting to your collaboration. This can be done via email or through other communication channels that are established in your organization. It is important that the contents of this invitation file are not intercepted and tampered with by any unknown entity. The invitation file is in the format collaboration-<guestHostDomain>.invite.

The administrator of the participant will accept the invitation by importing the invitation file into their portal. Their acceptance is returned to you as another file that you must import into your portal using the importInvitationResponse operation. This will establish trust between your portal and that of your participant.

The response for this operation is a file download that contains the invitation for the participant.

Request parameters

ParameterDetails
guestPortalUrl

The URL of the participating portal that you want to invite to the collaboration. The URL must be specified as HTTPS.

Example

guestPortalUrl=https://addmachine.org.com/webadaptor
collaborationWorkspacesParticipantConfigJSON

A JSON object containing a map of access modes for the participant in each of the collaboration workspaces. The possible access modes are: send, receive, sendAndReceive

Example

collaborationWorkspacesParticipantConfigJSON=[{"027e51c925584f2ba06729fa2ab4497f": "send"}]
expiration

The time in UTC when the invitation to collaborate should expire.

Example

expiration=24
f

The response formatting parameter. The default value is html.

Values: html | json | pjson