Public Access Controls
This feature is available on these plans: βοΈ Growing βοΈ Scaling βοΈ Enterprise
By default a public Space does not have any authentication method, but you can choose and set a few:
- Space-wide password;
- Guest accounts, where you manually create email + password combos and distribute them to your users;
- Magic Links, where you enter specific emails or entire domains, and users will authenticate using a link that we send on their email address;
- JWT, where your dev team generates a JWT with a secret key you provide in our UI, then pass it back to us as part of a link. This is the easiest to manage, but you will require developer time.
None
The default behaviour is set as None, meaning it is available publicly. You can change to controls to limit the access for readers.
Everyone with the link will be able to read content.
Links are safe to share because they are cryptographically generated and unguessable.
When you want to gate the contents to specific readers, try any of the options below.
Here is the breakdown of each control by each subscription plan:
Growing | Scaling | Enterprise |
Password | Password | Password |
ο»Ώ | Guest Accounts | Guest Accounts |
ο»Ώ | Magic Link | Magic Link |
ο»Ώ | JWT authentication | JWT authentication |
Guest Accounts
Create guest accounts. Everyone with the link and a guest account will be able to read the content. Guest accounts are not charged as seats in Archbee.
Magic Link
Users will be able to authenticate to your space with their email address if you add their email address or their email domain to the list below. Everyone with the link and a matched account will be able to read the content. Accounts are not charged as seats in Archbee.
JWT visitor authentication
Go to the Spaces settings, and set a JWT secret key that you generate on your server
ο»Ώ
Use one of the examples below to generate the JWT token.
You also need to replace the URL with the subdomain of your documentation site.
Here is an example to generate a JWT token with .NET: https://github.com/dragosbulugean/archbee-jwt-dotnetο»Ώ