Invitation | Inviting Guests

Overview

Cirrus Invitation provides an interface that can be used by sponsors to invite individuals to become a guest of the organization. This interface can be used interactively to invite small numbers of individuals or it can be used to upload a file to handle larger numbers.

Interactive

To use the interactive user interface:

  1. Log in to the Cirrus Console. For sponsors there should only be a menu option “Invitation Service” (administrators will have additional options as shown below)

  2. Select “Invite Guests” from the options at the left

  3. Follow the instructions from the application owner

  4. Provide one or more email addresses for the individuals you wish to invite

  5. Agree to the terms of service

  6. Press the “Send Invite” button

interactive_a.png

File upload

Format the list

Before the file can be uploaded, it must be properly formatted. Most customers will find using a spreadsheet application such as Microsoft Excel or Google Sheets a convenient way to compile and format such lists (this example will use Excel).

The file must also contain the data elements expected by your organization’s Cirrus deployment. Customers will typically use one of the following sets of data elements:

Basic List - A list that just contains email addresses. The first row must have the header name “emailAddress” exactly as shown.

excel_basic.png

List with Organization Data - A list where each row is an email address and organization identifiers (customData) associated with the individual. This customData will be specific to the organziation’s deployment. The first row must have the header names “emailAddress” and “customData” exactly as shown. The custom data elements are a comma separated list of key:value pairs in a single cell.

excel_with_data.png

Advanced - A list where each row is an email address and additional data elements to support integration. This can contain any of the elements permitted by the /api/v1/batchInviteCsv Cirrus API endpoint (see the Cirrus API Documentation for details).

excel_advanced.png

Prepare the list

Once you have the data compiled and formatted, Cirrus Identity expects the file to be a comma-separated-value (CSV) file. For Microsoft Excel, you would use the following dialog to export a spreadsheet as a CSV file.

excel_save_as.png

Upload the list

To use the file upload capability:

  1. Log in to the Cirrus Console. For sponsors there should only be a menu option “Invitation Service” (administrators will have additional options as shown below)

  2. Select “Upload File...” button on the right

  3. From the “Invitation File Upload” dialog, browse for the CSV file you created in the “Prepare the list” step

  4. Agree to the terms of service

  5. Press the “Upload” button -- your list will be processed in the background

file_upload_a.png
file_upload_b.png

You should see the following after a successful upload.

file_upload_c.png