Managing access to docs

Depending on your plan (and role), people with the Owner role for an organization (or Admin role on a project) can control who accesses the documentation associated with your Reference docs and Developer portals.

Single sign-on (SSO)

Enterprise customers can use SSO with either an OIDC or SAML2 connected identity provider. This will enable anyone with an account on their identity provider to read the docs.

Before you can set access control for your docs projects, you will need to set up your identity providers. For more information on how to do this, refer to the Configuring multiple identity providers (IdPs) topic.

In a docs project, you can control access to both the production and the preview environments separately.

Setting up access control for your Reference docs

Using these instructions, you can set up access control for your Reference docs using one of the identity providers you have previously configured.

  1. Log into Workflows, and select Reference docs. Ref docs list
  2. Select the Reference docs for which you want to set up access control. The Overview page is displayed. Ref docs overview
  3. Select Settings to view the Reference docs settings.
  4. On the Settings page, from the left, select Manage access.

The Manage Access page displays the following information:

  • Docs access: Displays the current access assigned for Production and Preview docs. To manage docs access, you can select Manage, which will allow you to set access controls on preview and production builds. For more information, refer to the Manage access to docs topic.
  • Base role: You can set base permissions that apply to all members of an organization when accessing any of the organization's projects. By default, members of an organization will have Maintain permissions to the organization's projects. To change the base role assigned to members, select Manage.
  • Direct access: Displays who outside your organization has access to your projects. You can invite a member (not currently part of your organization) to collaborate on your projects.
  • Manage direct access: You can use this section to select, remove or edit collaborators or teams for the selected project.

To set Production docs access, on the Production tile,

  • Select Manage. The Manage docs access dialog displays.
  • Select Protected and tick SSO login.
  • From the identity provider dropdown, select the identity provider you have set up to protect your Production docs. Select IDP SSO
  • Select Save to save your settings.
info

You can also control access to the docs previews for Reference docs, using these instructions.

Setting up access control for your Developer portal

Using these instructions, you can set up access control to your Developer portal using one of the identity providers you have previously configured.

Organization owners can control access individually for as many portals using any of the identity providers.

  1. In Redocly Workflows, select Portals. Portals list
  2. Select the Portal for which you want to set up access control. The Overview page is displayed. Portals overview
  3. Select Settings to view the Portal settings.
  4. On the Settings page, from the left, select Manage access.

The Manage Access page displays the following information:

  • Docs access: Displays the current access assigned for Production and Preview docs. To manage docs access, you can select Manage, which will allow you to set access controls on preview and production builds. For more information, refer to the Manage access to docs topic.
  • Base role: You can set base permissions that apply to all members of an organization when accessing any of the organization's projects. By default, members of an organization will have Maintain permissions to the organization's projects. To change the base role assigned to members, select Manage.
  • Direct access: Displays who outside your organization has access to your projects. You can invite a member (not currently part of your organization) to collaborate on your projects.
  • Manage direct access: You can use this section to select, remove or edit collaborators or teams for the selected project.

To set Production docs access, on the Production tile,

  • Select Manage. The Manage docs access dialog displays.
  • Select Protected and tick SSO login.
  • From the identity provider dropdown, select the identity provider you have set up to protect your Production docs. Select IDP SSO
  • Select Save to save your settings.
info

You can use these steps to control access to the docs previews for Developer portals.

Using HTTP Basic authentication

Instead of using the Redocly login or the SSO login, you can use HTTP Basic auth to set up basic username and passwords to restrict access to the docs. This is only available on docs projects (not snapshots). It is recommended to prevent spiders, or when you need to share a preview with someone outside of your organization.

Warning

Basic auth is not secure, so we recommend choosing the SSO login for the most secure access control.