ReadMe

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Setting Up Okta

Benefits

Setting up Okta and ReadMe allows members in your organization to authenticate with Okta and access various projects under ReadMe. In addition, you can set up Read Only members, which are limited to fewer privileges.

Required information

If you haven't already, please fill out the form in this link. Shoot us an email and once we've reviewed the information, we'll make some changes on our end to register it with our service.

Setting up Okta (without group + read only integration)

  1. As an admin in your Okta organization, add an application
  2. In the search input box, enter "ReadMe SAML" and add the application shown below
  3. View the "Sign On" in the application settings, and follow the instructions under "View Setup Instructions". The documentation in "View Setup Instructions" will give you all the credentials required to fill in the Typeform form.
Search for "ReadMe SAML"

Search for "ReadMe SAML"

"View Setup Instructions"

"View Setup Instructions"

How to configure SAML 2.0 for ReadMe SAML applications

You'll still be able to create readonly users when following this step. Follow these steps to assign a user as readonly.

Assign users as readonly by setting the value to true

Assign users as readonly by setting the value to true

  1. Assign a user to the application
  2. Set the value for "Readonly" to "true"

Setting up Okta (with groups + read only integration)

  1. In general, "Add an application"
  2. Click "Create New App"
  3. For the "Sign-On Method" option, choose the "SAML 2.0" option
  4. Enter your company name
  1. Set "Single sign on URL" and "Audience URI" of "SAML Settings" to "https://sso.readme.io/okta/login/callback/{YOUR_COMPANY_NAME}"
  1. Set these attributes under the "Attribute settings". The readonly value can be any value that matches your definition of a readonly user. For instance, it can be isMemberOfGroupName("Read Only"). For more information on the features for determining readonly users, check out Okta's expression language documentation
  1. Finish creating your application
  2. Navigate to the "Sign On" settings of your application and use the "View Setup Instructions" of the application to fill out this form. Refer to this documentation created by the Okta devs for further help.
  3. Once you fill out this form, shoot us a message and we'll set up the dependencies to finalize your Okta configuration!

Setting Up Okta