website: latest PR for new Docs structure (#11639)

* first pass * dependency shenanigans * move blueprints * few broken links * change config the throw errors * internal file edits * fighting links * remove sidebarDev * fix subdomain Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix relative URL Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix mismatched package versions Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix api reference build Signed-off-by: Jens Langhammer <jens@goauthentik.io> * test tweak * links hell * more links hell * links hell2 * yep last of the links * last broken link fixed * re-add cves Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add devdocs redirects * add dir * tweak netlify.toml * move latest 2 CVES into dir * fix links to moved cves * typoed title fix * fix link * remove banner * remove committed api docs Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> * integrations: remove version dropdown Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> * Update Makefile Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> * change doc links in web as well Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> * fix some more docs paths Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> * fix more docs paths Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> * ci: require ci-web.build for merging Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> * Revert "ci: require ci-web.build for merging" This reverts commit b99a4842a9. * remove sluf for Application * put slug back in * minor fix to trigger deploy * Spelled out Documentation in menu bar * remove image redirects... Signed-off-by: Jens Langhammer <jens@goauthentik.io> * remove explicit index.md Signed-off-by: Jens Langhammer <jens@goauthentik.io> * remove mdx first Signed-off-by: Jens Langhammer <jens@goauthentik.io> * then remove .md Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add missing prefix Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: Jens Langhammer <jens@goauthentik.io> Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> Co-authored-by: Tana M Berry <tana@goauthentik.com> Co-authored-by: Jens Langhammer <jens@goauthentik.io> Co-authored-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
2024-10-09 09:33:40 -05:00
parent 6b2fced1b9
commit 6d5172d18a
336 changed files with 2138 additions and 872 deletions
--- a/website/docs/users-sources/user/invitations.md
+++ b/website/docs/users-sources/user/invitations.md
@ -0,0 +1,49 @@
+---
+title: Invitations
+description: "Learn how to create an invitation URL for new users to enroll."
+---
+
+Invitations are another way to create a user, by inviting someone to join your authentik instance, as a new user. With invitations, you can either email an enrollment invitation URL to one or more specific recipients with pre-defined credentials, or you can email a URL to users, who can then log in and define their own credentials.
+
+:::info
+You can also create a policy to see if the invitation was ever used.
+:::
+
+## Create an invitation
+
+The fastest way to create an invitation is to use our pre-defined `default-enrollment-flow` that has the necessary stages and prompts already included.
+
+**Step 1. Download the `default-enrollment-flow` file**
+
+To download the `default-enrollment-flow` file, run this command:
+
+```shell
+wget https://goauthentik.io/blueprints/example/flows-enrollment-2-stage.yaml
+```
+
+Alternatively, use this [link](/blueprints/example/flows-enrollment-2-stage.yaml) to view and save the file. For more details, refer to the [documentation](https://goauthentik.io/docs/flow/examples/flows#enrollment-2-stage).
+
+**Step 2. Import the `default-enrollment-flow` file**
+
+In authentik, navigate to the Admin UI, and then click **Flows** in the left navigation pane.
+
+At the top of the Flows page, click **Import**, and then select the `flows-enrollment-2-stage.yaml` file that you just downloaded.
+
+**Step 3. Create the invitation object**
+
+In the Admin UI, navigate to **Directory --> Invitations**, and then click **Create** to open the **Create Invitation** modal. Define the following fields:
+
+-   **Name**: provide a name for your invitation object.
+-   **Expires**: select a date for when you want the invitation to expire.
+-   **Flow**: in the drop-down menu, select the **default-enrollment-flow** Flow.
+-   **Custom attributes**: (_optional_) enter optional key/value pairs here, to pre-define any information about the user that you will invite to enroll. The data entered here is considered as a variable, specifically the `context['prompt_data']` variable. This data is read by the context flow's [prompt stage](../../add-secure-apps/flows-stages/stages/prompt/index.md) in an expression policy.
+
+![Create an invitation modal box](./create_invite.png)
+
+-   **Single use**: specify whether or not you want the invitation to expire after a single use.
+
+Click **Save** to save the new invitation and close the modal and return to the **Invitations** page.
+
+**Step 3. Email the invitation**
+
+On the **Invitations** page, click the chevron beside your new invitation, to expand the details. The **Link to use the invitation** displays with the URL. Copy the URL and send it in an email to the people you want to invite to enroll.