Inviting collaborators allows you to share access to specific applications while preserving full control and accountability. This feature is designed to support seamless teamwork from development to production.

Granting collaborator access should be done with care. While collaborators cannot delete an application, they still hold sufficient privileges to modify configurations, deploy new code, or scale resources. These actions can impact the stability or availability of your services.

Consequently, it is essential to assign new collaborators the appropriate role based on their responsibilities. Roles define the level of access and actions a user can perform on your applications and databases.

Listing all Collaborators

Using the Dashboard

1. From your web browser, open your dashboard
2. The consolidated list of all users collaborating on all your apps, along with their 2FA status, is available from the Collaborators tab
3. (optional) The Group by buttons allow to group the list either by collaborator or by app.

Exporting Collaborators

Using the Dashboard

1. From your web browser, open your dashboard
2. Click the Collaborators tab
3. Click the Export as CSV button to export the list of collaborators in CSV format. The list is also available in JSON format from the drop-down.

Listing Collaborators of an App

Using the Dashboard

1. From your web browser, open your dashboard
2. Click the Apps tab
3. Click on the application for which you want to manage your collaborators
4. Click the Settings tab
5. In the Settings submenu, make sure to select Collaborators

Using the Command Line

1. Make sure you have correctly setup the Scalingo command line tool
2. From the command line, list le collaborators of the app:

   scalingo --app my-app collaborators
   

   The output should look like this:

   ┌──────────────────────────────┬──────────┬──────────┐
   │            EMAIL             │ USERNAME │  STATUS  │
   ├──────────────────────────────┼──────────┼──────────┤
   │ user1@example.com            │ user1    │ owner    │
   │ user2@example.com            │ user2    │ accepted │
   │ user3@example.com            │ n/a      │ pending  │
   └──────────────────────────────┴──────────┴──────────┘
   

Inviting a Collaborator

Using the Dashboard

1. From your web browser, open your dashboard
2. Click the Apps tab
3. Click on the application for which you want to add a collaborator
4. Click the Settings tab
5. In the Settings submenu, make sure to select Collaborators
6. Click the Add button
7. Fill the input field with the e-mail address of the collaborator. If they already have a Scalingo account, use this e-mail address
8. By default, the new collaborator is assigned the Limited Collaborator role. If the user requires broader access and responsibilities, select the Collaborator role from the dropdown. To choose the right role, see Understanding Roles
9. The collaborator is added, and shows up dimmed in the list
10. An invite is sent by e-mail to the collaborator
11. Once the invite accepted, the collaborator shows up normally in the list

Using the Command Line

1. Make sure you have correctly setup the Scalingo command line tool
2. From the command line, invite someone:

   scalingo --app my-app collaborators-add user@example.com
   

   The output should look like this:

   -----> user@example.com has been invited to collaborate to my-app
   

Using the Terraform Provider

1. Place the following resource block in your Terraform file:

   locals {
     team = ["user1@example.com", "user2@example.com"]
   }
   
   resource "scalingo_collaborator" "collaborators" {
     for_each = toset(local.team)
   
     app   = "${scalingo_app.my-app.id}"
     email = each.key
   }
   

   In this example, we invite two users (user1@example.com and user2@example.com) to work on an app named my-app (which must exist).

Updating a Collaborator’s Role

Using the Dashboard

1. From your web browser, open your dashboard
2. Click the Apps tab
3. Click on the application for which you want to update a collaborator
4. Click the Settings tab
5. In the Settings submenu, make sure to select Collaborators
6. Locate the collaborator for whom you want to update the role
7. Open the contextual menu by clicking the corresponding … button
8. Select Change role
9. In the popup window, select the new role
10. Confirm by clicking the Change role button

Removing a Collaborator

Using the Dashboard

1. From your web browser, open your dashboard
2. Click the Apps tab
3. Click on the application for which you want to add a collaborator
4. Click the Settings tab
5. In the Settings submenu, make sure to select Collaborators
6. Locate the collaborator for whom you want to revoke access
7. Open the contextual menu by clicking the corresponding … button
8. Select Revoke access
9. Confirm by clicking the Delete user@example.com button in the popup window

Using the Command Line

1. Make sure you have correctly setup the Scalingo command line tool
2. From the command line, revoke the access:

   scalingo --app my-app collaborators-remove user@example.com
   

   The output should look like this:

   -----> user@example.com has been removed from the collaborators of my-app
   

Using the Terraform Provider

1. Remove the collaborator e-mail address from the list of collaborators. The following example removes user1@example.com from the list of collaborators.
   Before:

   locals {
     team = ["user1@example.com", "user2@example.com"]
   }
   

   After:

   locals {
     team = ["user2@example.com"]
   }
   

Stopping Collaborating

If you are currently working collaboratively on an application and have no more interests into participating in it, you can stop collaborating on your own.

Using the Dashboard

1. From your web browser, open your dashboard
2. Click the Apps tab
3. Click on the application for which you want to stop collaborating with
4. Click the Settings tab
5. In the Settings submenu, make sure to select Collaborators
6. Locate yourself in the list of collaborators
7. Open the contextual menu by clicking the corresponding … button
8. Select Revoke access
9. Confirm by clicking the Delete user@example.com button in the popup window

Monitoring Collaborators

The following events are available to monitor the collaborators:

To learn more about events and notifications, please visit the page dedicated to app notifications.