Skip to main content

Styleguide security

Vinh
Vinh
  • Updated

Public vs Private styleguides

Styleguides can either be public or private. This can be configured for each styleguide from the styleguide settings. This means you can have one styleguide that is private and another that is public.

Public styleguide options

There is one option for public styleguides, available on all plans.

🌍 Discoverable on the internet All plans If you link to the styleguide on a public website, the styleguide will be discoverable on the internet. You can also have your styleguide indexed by search engines. Learn more here.

Private styleguide options

There are several options for private styleguides, only available on paid plans. You can choose these options in combination.

🔐 Password protected

 

Starter The styleguide is accessible to anyone with the password.
🗝 Single-Sign On Enterprise Viewers of the styleguide must log in using their SSO credentials.
🖥 Trusted IP range Enterprise

Anyone in the trusted IP range has access to the team's styleguides.

Contact support@zeroheight.com to set up IP whitelisting.

Invite viewers by email

You can also invite external contractors, agencies, etc to a private styleguide via email. This means you can restrict your styleguide using SSO but still give access to people outside of your organization.

Change your styleguides security

1) Open your styleguide

2) Click the three dots at the top of the page and choose Styleguide settings from the menu

Styleguide settings hovered in three dots menu

3) Click the Security tab

4) Select your security option

You can control access to your style guide using the following settings:

A. Public

  • Anyone with the link can view the style guide.

  • No authentication required.

B. Private
Access is restricted. You can apply one or more protection methods:

  • Password protection

    • Set a password required to view the style guide.

  • Single Sign-On (SSO) (available if enabled for your team)

    • Only authenticated users from your organisation can access the style guide.

  • Password + SSO

    • Require both SSO authentication and a password to access the style guide.

SSO viewer groups

By default, any viewer with SSO access to zeroheight can view any SSO-protected styleguides. SSO viewer groups let you restrict access to specific styleguides — so only users in designated identity provider groups can view them.

Setup has two steps:

  1. Configure the SAML attribute key in your team's SSO settings
  2. Add allowed groups to each styleguide

Step 1: Configure the SAML attribute key

zeroheight needs to know which SAML attribute contains your users' group membership. This is typically set up by your IT or SSO admin — if you're unsure of the attribute name, check with them before proceeding.

In your SSO settings:

  1. Check Enable SAML attribute
  2. Enter the attribute key (e.g. team, department, groups)
  3. Click Save updates

Step 2: Add allowed groups to a styleguide

Once the SAML attribute key is saved, go to the settings for the styleguide you want to restrict.

Under Security > SSO viewer groups:

  1. Enter a group name in Add a group name — this must exactly match the value in your identity provider
  2. Click Add group
  3. Repeat for any additional groups
  4. Click Save
Share this article
Was this article helpful?