---
# System prepended metadata

title: Invitations Interface

---

# Invitations Interface
The invitations component is designed to allow users to manage their invitations. 

## How to create an invitation
The round blue button in the bottom right corner allows the user to create a new invitation.

#1 Once the button has been pressed an invitation create modal opens.

#2 There are nine form fields that will need to be filled out in order to create an invitation:
* Alias - **name of invitation** *
* Invitation Mode - **once, multi or static** *
* Accept - **manual or auto** *
* Their Role - **role of invitation**
* Their Label - **invitation label**
* Workflow Status - **active, inactive or deleted** *
* Description - **purpose of invitation**
* Active Starting Time - **when the invitation will be activated**
* Active Ending Time - **when the invitation will be deactivated**

> After all the form fields are properly filled out, clicking the 'Submit' button will create an invitation, which will appear in the invitation table.

### Notes
The asterisk ( * ) symbol indicates a field is required to create an invitation.

If 'multi' has been selected for invitation mode, another form field will appear called 'Uses Allowed' that will determine how many times the invitation can be used.

## Invitation Management
The invitation table consists of four columns:
* Alias
* Connection ID
* Type
* Created At

### Alias
The alias specified when creating an invitation appears here, usually associated with what the invitation will be used for.

### Connection ID
Connection ID is automatically created when an invitation has successfully been created and is used internally to keep track of invitations. 

### Type
Type of invitation is also known as 'Invitation Mode'. There are three types of invitations: once, multi and static.

### Created at
The time that the invitation was created will display here. 

## How to manage invitations

#1 When viewing the invitations table, click on the invitation you'd like to manage.

#2 You will be brought to invitation details page, where you can view the following details:
* Invitation ID - **invitation ID**
* Connection ID - **internal identifier**
* Invitation Key - **public key for connection**
* Invitation Mode - **once, multi or static**
* Accept - **manual or auto**
* Their Role - **role of invitation**
* Their Label - **label of invitation**
* Service Endpoint - **TBD**
* Domain - **TBD**
* Path - **TBD**
* Workflow Status - **active, inactive or deleted**
* Description - **purpose of invitation**
* Active Starting Time - **when the invitation will be activated**
* Active Ending Time - **when the invitation will be deactivated**
* Uses Allowed - **how many times the invitation can be used**
* Uses Remaining - **how many remaining uses are left**
* Created At - **when the invitation was created**
* Updated At - **when the invitation was updated**
* User ID - **TBD**
* Invitation URL - **URL of the invitation**
* Invitation QR Code with the ability to download
* 'Remove' invitation button - **deleting the invitation**


