Skip to content

Commit fecf411

Browse files
authored
Merge pull request #798 from zihanKuang/update-invitattion
Update User Invitations documentation
2 parents bcae96d + b0d169d commit fecf411

File tree

3 files changed

+22
-4
lines changed

3 files changed

+22
-4
lines changed
108 KB
Loading
185 KB
Loading

content/en/cloud/identity/users/user-invitations/index.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ categories: [Identity]
77
tags: [users]
88
---
99

10-
The new invitation system gives you precise control over how members join your organization, allowing you to streamline onboarding and enhance security.
10+
The [invitation system](https://cloud.layer5.io/identity/invitations) gives you precise control over how members join your organization, allowing you to streamline onboarding and enhance security.
1111

1212
You can create highly customized invitations for any scenario, from onboarding specific individuals to launching large-scale community challenges. Each invitation can be configured with expiration dates, usage quotas, and pre-assigned roles, ensuring new members get the right access from the moment they join.
1313

@@ -37,11 +37,13 @@ If `expiresAt` is not set, the invitation never expires. If `quota` is not set,
3737
#### Manage invitations dynamically
3838
Instantly revoke access by switching an invitation's status between enabled and disabled at any time.
3939

40-
<!-- ### How to create an invitation -->
40+
### How to create an invitation
4141

42-
<!-- ### Managing existing invitations -->
42+
To create a new invitation, navigate to the [Invitations page](https://cloud.layer5.io/identity/invitations) from the main menu. Click the **Create Invitation** button to open the creation dialog.
4343

44-
### Invitation properties explained
44+
<img src="./images/create-invitation.png" alt="Create Invitation Dialog" style="width:30%; height:auto;" />
45+
46+
#### Invitation properties explained
4547

4648
| Property | Description |
4749
| :--- | :--- |
@@ -53,10 +55,26 @@ Instantly revoke access by switching an invitation's status between enabled and
5355
| `roles` | List of roles automatically assigned to new members upon accepting the invitation. |
5456
| `teams` | List of teams new members are automatically added to upon accepting the invitation. |
5557

58+
### Managing existing invitations
59+
60+
All existing invitations are displayed in a table that shows key invitation information.
61+
62+
![Invitations Overview Table ](./images/overview.png)
63+
64+
From this overview table, you can perform several management actions:
65+
66+
* **Copy Link**: Click the copy icon to copy the invitation URL for sharing.
67+
* **Edit Invitation**: Click the pencil icon to open the edit dialog and modify invitation properties.
68+
* **Change Status**: Toggle between `Enabled` and `Disabled` to control whether the invitation can be accessed by users.
69+
5670
### Use cases and examples
5771

5872
The invitation system offers flexible configurations to fit a variety of use cases.
5973

74+
{{< alert type="info" title="How Invitation Links Handle Logins" >}}
75+
When a user who is not logged in clicks an invitation link, the system temporarily saves the invitation ID in a 30-minute cookie and redirects them to the login page. After a successful login, the system reads the cookie and seamlessly guides them back to complete the invitation acceptance process.
76+
{{< /alert >}}
77+
6078
#### Scenario 1: Inviting a single team member
6179

6280
- Goal: Provide a new employee with a secure, single-use invitation that grants the correct initial permissions.

0 commit comments

Comments
 (0)