Setting Up Access Control
Setting up access is tricky. We're here to help though! We've taken a couple of measures to make sure that we can support some common use cases that our enterprise clients have. Here, we'll take a look at how some of our customers are integrating their SAML access to manage private access.
We think it's useful to think about your access in two main channels: internal & external.
With that being said, there are a few ways you can set up access. Below, we'll lay out each steps on how to implement a solution:
- My documentation is totally private and I want my external users to log in via SAML
- Some of my projects will be private and I want my external users to log in via SAML
- I want my internal users to log in via SAML and I want my external users to log in via Custom OAuth.
- I have a totally custom solution and want my users to log in via that.
Did you set up SAML yet?
If you haven't set up your SAML set up yet, check out this page to help with getting started. In addition, this guide assumes that you have an enterprise parent project set up with ReadMe.
Scenario 1: My documentation is totally private and I want my external users to log in via SAML
We'll divide up the work into two pieces:
- Setting up the private docs
- Setting up your login mechanisms
Setting up private docs
Setting this up is quite easy. First, go to the Projects page in your Enterprise Group dashboard. From there, click the Public/Private dropdown, and select Private so that only Teammates and End Users with permissions can access the project's developer hub. You also have the option to set a password for private docs.
Setting up your login mechanism
We have four login mechanisms. When you have correctly set up your project, you will be able to control how your End Users will log in to the private project. One thing to note is that you may not need to set this up. If you have set up SAML already, your End Users users will already be prompted to log in with SAML.
Scenario 2: Some of my projects will be private and I want my End Users users to log in via SAML
This is very similar to scenario 1. All you would need to do to keep some docs public is to determine which ones you want private and only toggle those ones.
Scenario 3: I have a totally custom solution and want my external users to log in via that.
If you want to do this, you can use a custom login URL which you can specify here:
Updated 27 days ago