Skip to content

Commit 77b5baf

Browse files
committed
finish doc for content invitation
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
1 parent ff98921 commit 77b5baf

5 files changed

Lines changed: 68 additions & 7 deletions

File tree

content/en/cloud/academy/using-the-academy/index.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,53 @@ Completing content in the Academy earns you valuable credentials that you can sh
126126

127127
**Certificates**: You earn an official Certificate of Completion after passing a Certification exam. While the learning and exams are free, the issuance of the official certificate is an optional, paid feature.
128128

129+
## Joining Through Invitations
130+
131+
You can invite people to join the Academy. Learn [how to create invitations](../../identity/users/user-invitations/index.md/#how-to-create-an-invitation).
132+
The Academy supports two distinct roles, each with its own invitation process and access levels.
133+
134+
After the invitation is created, there are two different invitation flows based on the assigned role.
135+
136+
### Academy Admin
137+
138+
Academy administrators have full management capabilities and follow this invitation flow:
139+
140+
1. **Receive admin invitation**: You'll get an invitation link via email with administrative privileges.
141+
2. **Accept invitation**: Click the invitation link to gain full administrative access
142+
3. **Access instructor console**: Navigate to the instructor dashboard to manage content
143+
4. **Manage content and analytics**: Create, edit, and monitor learning content while viewing detailed analytics
144+
145+
**Scenario**: Onboarding a new training coordinator
146+
147+
- Goal: Grant administrative access to a new team member who will manage Academy content and oversee learner progress.
148+
- Configuration:
149+
- Email: Set to the coordinator's specific email address.
150+
- Roles: Assign `Academy Admin` role for full administrative privileges.
151+
- Teams: Add to `Academy-Management` team for collaboration with other administrators.
152+
- Quota: Set to `1` for secure, single-use access.
153+
- Description: "New training coordinator - full Academy management access".
154+
155+
### Academy Learner
156+
157+
Learners join the Academy to access educational content through this streamlined process:
158+
159+
1. **Receive content invitation**: You'll get an invitation link via email to join Academy content.
160+
2. **Accept invitation**: Click the link to automatically join the organization
161+
3. **Auto-enrollment**: You're automatically added to the organization and assigned teams
162+
4. **Gain content access**: Receive Academy Content Access permissions
163+
5. **Start learning**: Access all learning materials and enroll in courses
164+
165+
**Scenario**: Enrolling new employees in company training program
166+
167+
- Goal: Provide streamlined access to Academy learning content for new hires as part of their onboarding process.
168+
- Configuration:
169+
- Email: Use company domain pattern (e.g., `*@company.com`) to allow all employees to join.
170+
- Roles: Assign `Academy Learner` role for access to learning materials.
171+
- Teams: Add to `Company-Training-Cohort` team to track progress collectively.
172+
- Expiration date: Set to end of training period (e.g., 90 days from creation).
173+
- Description: "Q1 2025 new employee training program access".
174+
175+
129176
## Frequently Asked Questions
130177

131178
<details>
103 KB
Loading
264 KB
Loading
162 KB
Loading

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

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,23 @@ To create a new invitation, navigate to the [Invitations page](https://cloud.lay
4343

4444
<img src="./images/create-invitation.png" alt="Create Invitation Dialog" style="width:30%; height:auto;" />
4545

46+
After the invitation is created, the invitee will receive an email with the invitation details.
47+
48+
<img src="./images/invitation-email.png" alt="Invitation Email" style="width:50%; height:auto;" />
49+
50+
4651
#### Invitation properties explained
4752

4853
| Property | Description |
4954
| :--- | :--- |
50-
| `name` | A name used to identify the invitation. |
51-
| `description` | Additional information about the invitation's purpose. |
52-
| `emails` | List of email addresses or domain patterns allowed to use the invitation. If empty, the invitation is public. |
53-
| `expiresAt` | Date when the invitation becomes invalid. If not set, it never expires. |
54-
| `quota` | Number that limits how many users can accept the invitation. If not set, there's no usage limit. |
55+
| `emails` | List of email addresses or domain patterns allowed to use the invitation. If empty, the invitation is public. |
5556
| `roles` | List of roles automatically assigned to new members upon accepting the invitation. |
5657
| `teams` | List of teams new members are automatically added to upon accepting the invitation. |
58+
| `quota` | Number that limits how many users can accept the invitation. If not set, there's no usage limit. |
59+
| `expiresAt` | Date when the invitation becomes invalid. If not set, it never expires. |
60+
| `status` | Invitation status: enabled = active/usable; disabled = inactive (can be re-enabled later). |
61+
| `name` | A name used to identify the invitation. |
62+
| `description` | Additional information about the invitation's purpose. |
5763

5864
### Managing existing invitations
5965

@@ -65,7 +71,7 @@ From this overview table, you can perform several management actions:
6571

6672
* **Copy Link**: Click the copy icon to copy the invitation URL for sharing.
6773
* **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.
74+
* **Delete Invitation**: Click the trash icon to delete the invitation.
6975

7076
### Use cases and examples
7177

@@ -116,4 +122,12 @@ The available seats for learners are determined by your organization's subscript
116122

117123
{{< alert type="warning" title="Public invitations" >}}
118124
Public links can be forwarded broadly. Always set an expiration date and a quota.
119-
{{< /alert >}}
125+
{{< /alert >}}
126+
127+
#### Scenario 5: Onboarding a new training coordinator
128+
129+
See detailed example in [Academy Admin invitations](../../../academy/using-the-academy/#academy-admin).
130+
131+
#### Scenario 6: Enrolling new employees in company training program
132+
133+
See detailed example in [Academy Learner invitations](../../../academy/using-the-academy/#academy-learner).

0 commit comments

Comments
 (0)