mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
95f4f641b5
https://linear.app/unleash/issue/2-1136/custom-root-roles-documentation - [Adds documentation referencing custom root roles](https://unleash-docs-git-docs-custom-root-roles-unleash-team.vercel.app/reference/rbac); - [Adds a "How to create and assign custom root roles" how-to guide](https://unleash-docs-git-docs-custom-root-roles-unleash-team.vercel.app/how-to/how-to-create-and-assign-custom-root-roles); - Standardizes "global" roles to "root" roles; - Standardizes "standard" roles to "predefined" roles to better reflect their behavior and what is shown in our UI; - Updates predefined role descriptions and makes them consistent; - Updates the side panel description of the user form; - Includes some boy scouting with some tiny fixes of things identified along the way (e.g. the role form was persisting old data when closed and re-opened); Questions: - Is it worth expanding the "Assigning custom root roles" section in the "How to create and assign custom root roles" guide to include the steps for assigning a root role for each entity (user, service account, group)? - Should this PR include an update to the existing "How to create and assign custom project roles" guide? We've since updated the UI; --------- Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
26 lines
1.4 KiB
Plaintext
26 lines
1.4 KiB
Plaintext
---
|
|
title: Public Invite Links
|
|
---
|
|
|
|
Public invite links let you invite team members to your Unleash instance. Any user with an invite link can sign up to Unleash instance that created the link. The user will get the **viewer** role (refer to the [predefined roles_ section of the RBAC document](../reference/rbac.md#predefined-roles) for more information on roles).
|
|
|
|
User who follow the invite link are taken directly to the Unleash sign-up page, where they can create an account.
|
|
|
|
Only **Unleash instance admins** can create public invite links.
|
|
|
|
|
|
|
|
## Public sign-up tokens
|
|
|
|
The most important part of a public sign-up link is the sign-up token. The token is added as the `invite` query parameter to the invite link.
|
|
|
|
Each token has an **expiry date**. After this expiry date, the token will stop working and users can no longer sign up using an invite link with that token.
|
|
|
|
## Creating, updating, and deleting tokens
|
|
|
|
You can [create, update and delete tokens via the Unleash Admin UI](../how-to/how-to-manage-public-invite-tokens.mdx) or via the [Unleash API](../reference/api/unleash/public-signup-tokens.tag.mdx "Public sign-up tokens API documentation").
|
|
|
|
A token is active as soon as it's created and stops working as soon as it's deleted or expired.
|
|
|
|
You can only have one active invite token at a time. If you already have an active token, you must delete it to create a new one.
|