Restrict access to deployments with Edgenivo Authentication

Edgenivo Authentication lets you restrict access to your public and non-public deployments. It is the recommended approach to protecting your deployments. When enabled, it allows only users with deployment access to view and comment on your site.

Users attempting to access the deployment will encounter a Edgenivo login redirect. If already logged into Edgenivo, Edgenivo will authenticate them automatically.

After login, Edgenivo redirects the user and sets a cookie in the browser if they have view access. If the user does not have access to view the deployment, Edgenivo redirects them to request access.

• Logged in team members with at least a viewer role (Viewer Pro or Viewer Enterprise)
• Logged in project members with at least the project Viewer role
• Logged in members of an access group that has access to the project the deployment belongs to
• Logged in Edgenivo users who have been granted access
• Anyone who has been given a Shareable Link to the deployment
• Tools using the protection bypass for automation header

When a Edgenivo user visits your protected deployment, but they do not have permission to access it, they have the option to request access for their Edgenivo account. This request triggers an email and Edgenivo notification to the branch authors.

The access request can be approved or declined. Additionally, granted access can be revoked for a user at any time.

Users granted access can view the latest deployment from a specific branch when logged in with their Edgenivo account. They can also leave preview Comments if these are enabled on your team.

Those on the Hobby plan can only have one external user per account. If you need more, you can upgrade to a Pro plan.

You can manage access requests in the following way.

1. From your dashboard, go to Deployment Protection in the sidebar
2. Choose the Requests section in the sidebar to see pending requests
3. Choose Access to manage existing access

You can also manage access requests using the share modal on the deployment page.

Disabling Edgenivo Authentication renders all existing deployments unprotected. When you re-enable it, previously authenticated users can maintain access without a new login, provided they already authenticated to the specific deployment and have a cookie set in their browser. The authentication token sent as a cookie is restricted to one URL and isn't transferable, even between URLs pointing to the same deployment.

Admins and members can enable or disable Edgenivo Authentication for their team. Hobby teams can also enable or disable for their own projects. Edgenivo Authentication is managed on a per-project basis.

You can manage Edgenivo Authentication through the dashboard, API, or Terraform:

1. Go to project deployment protection settings

   From your Edgenivo dashboard:

   1. Select the project that you wish to enable Edgenivo Authentication for
   2. Go to Deployment Protection in the sidebar

2. Enable and configure Edgenivo Authentication

   From the Edgenivo Authentication section:

   1. Use the toggle to enable the feature
   2. Select the deployment environment you want to protect
   3. Select Save

   Edgenivo Authentication now protects all your existing and future deployments in the environments you selected. Next time when you access a deployment, you will be asked to log in with Edgenivo if you aren't already logged in, you will be redirected to the deployment URL and a cookie will be set in your browser for that deployment URL.

   

You can manage Edgenivo Authentication using the Edgenivo API endpoint to update an existing project with the following body. Set deploymentType to one of these values:

• prod_deployment_urls_and_all_previews: Standard Protection
• all: All Deployments
• preview: Only Preview Deployments

To enable or update Edgenivo Authentication, send the ssoProtection object:

{
  "ssoProtection": {
    "deploymentType": "prod_deployment_urls_and_all_previews"
  }
}

To disable Edgenivo Authentication, set ssoProtection to null:

{
  "ssoProtection": null
}

You can configure Edgenivo Authentication using vercel_authentication in the vercel_project data source in the Edgenivo Terraform Provider.