1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
unleash.unleash/website/docs/reference/public-signup.mdx

26 lines
1.4 KiB
Plaintext
Raw Normal View History

Docs/public signup (#2070) * update snapshot * add api doc * describe api * reference initial * updated public signup api docs created public invite api docs * docs * docs update * docs update * add description to openapi endpoints * add description to openapi endpoints * fix snapshot * Update src/lib/openapi/spec/public-signup-token-create-schema.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/openapi/spec/public-signup-token-schema.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/routes/admin-api/public-signup.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/routes/public-invite.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/openapi/spec/public-signup-token-schema.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/routes/admin-api/public-signup.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/reference/public-signup.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * PR comments * delete api docs * fix snapshot * Update src/lib/routes/admin-api/public-signup.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * bug fix * bug fix * bug fix * Update src/lib/openapi/spec/public-signup-token-create-schema.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/openapi/spec/public-signup-token-schema.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/openapi/spec/public-signup-token-update-schema.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/routes/admin-api/public-signup.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/routes/admin-api/public-signup.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/routes/public-invite.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * bug fix * fix links * update snapshot * update snapshot Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-10-10 15:12:11 +02:00
---
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).
Docs/public signup (#2070) * update snapshot * add api doc * describe api * reference initial * updated public signup api docs created public invite api docs * docs * docs update * docs update * add description to openapi endpoints * add description to openapi endpoints * fix snapshot * Update src/lib/openapi/spec/public-signup-token-create-schema.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/openapi/spec/public-signup-token-schema.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/routes/admin-api/public-signup.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/routes/public-invite.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/openapi/spec/public-signup-token-schema.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/routes/admin-api/public-signup.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/reference/public-signup.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * PR comments * delete api docs * fix snapshot * Update src/lib/routes/admin-api/public-signup.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * bug fix * bug fix * bug fix * Update src/lib/openapi/spec/public-signup-token-create-schema.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/openapi/spec/public-signup-token-schema.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/openapi/spec/public-signup-token-update-schema.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/routes/admin-api/public-signup.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/routes/admin-api/public-signup.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/lib/routes/public-invite.ts Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * bug fix * fix links * update snapshot * update snapshot Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-10-10 15:12:11 +02:00
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.
![An Unleash signup form for new users](/img/public-invite_signup.png)
## 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.