Skip to content

Commit ab08239

Browse files
committed
finish
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
1 parent 3407a64 commit ab08239

File tree

1 file changed

+116
-2
lines changed
  • content/en/cloud/academy/creating-content/using-content-template-creator

1 file changed

+116
-2
lines changed

content/en/cloud/academy/creating-content/using-content-template-creator/index.md

Lines changed: 116 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,121 @@ After generating our template:
135135
3. **Add Your Content**: Replace the placeholder comment with your actual learning material
136136

137137

138-
### Invitation
138+
## Manage Invitation
139139

140+
### Auto-Generated Invitations
141+
Navigate to **Identity → Invitations** to find your automatically created invitation.
140142
![](images/auto-invitation.png)
141-
![](images/auto-invitation-details.png)
143+
144+
The first column labeled "INVITATION" contains a shareable link that you can copy.
145+
146+
## What Can the Invitation Link Do for You?
147+
148+
The auto-generated invitation link is a powerful tool that helps instructors efficiently manage learner access and streamline the enrollment process.
149+
150+
### 1. Precise Team Access Control
151+
152+
Your invitation link provides targeted access management:
153+
154+
- **Specific Team Access**: Only members of your selected teams can access the content through this link
155+
- **Automatic Role Assignment**: Users who accept the invitation automatically receive the "Academy Learner" role
156+
- **Organization Boundary Protection**: Only users within your [organization](https://docs.layer5.io/cloud/identity/organizations/) can use this invitation
157+
158+
### 2. Flexible Sharing and Distribution
159+
160+
**Automated Email Distribution:**
161+
- The system automatically sends invitation emails to specified team members
162+
- Emails include course descriptions and one-click access links
163+
- Reduces your manual notification workload and ensures consistent messaging
164+
165+
**Direct Sharing Options:**
166+
- Copy and send the invitation link directly to team members
167+
- Share through collaboration tools like Slack, Microsoft Teams, or Discord
168+
- Embed the link in internal documentation, wikis, or learning portals
169+
170+
171+
### Customize Invitation Properties
172+
173+
Click the pencil icon to access the invitation customization form.
174+
![](images/auto-invitation-details.png)
175+
176+
The invitation form contains eight properties. Three are automatically generated by the system for convenience, which you can modify according to your needs:
177+
178+
**Auto-Generated Properties:**
179+
1. **Name**: Automatically formatted as "Academy Invitation for [your-content-name]"
180+
*Example: "Academy Invitation for meshery-contributors-certification" (lowercase with dash)*
181+
2. **Description**: "Invitation to join organization [organization-name] for academy curricula [course-name]"
182+
3. **Roles**: Defaults to "Academy Learner" - [Learn more about Academy roles](https://docs.layer5.io/cloud/security/roles/academy-roles/)
183+
184+
{{< alert type="info" title="Admin Role Invitations" >}}
185+
Academy admins can invite other instructors to become co-admins by changing the **Roles** property from "Academy Learner" to "Academy Admin" during invitation customization.
186+
{{< /alert >}}
187+
188+
**Customizable Properties:**
189+
190+
### 1. Emails - Invitation Email List
191+
192+
Configure who receives the invitation:
193+
194+
- **Supported Formats:**
195+
- Individual emails: `test@domain.com`
196+
- Domain-wide invitations: `@domain.com` (invites all users from that domain)
197+
- **Duplicate Handling**: The system automatically merges duplicate entries
198+
- **Quantity Recommendations:**
199+
- Small team invitations: 10-50 email addresses
200+
- Department-level invitations: 100-200 email addresses
201+
- Large organizations: Use domain wildcards like `@company.com` instead of listing individual emails
202+
203+
### 2. Expires At - Expiration Settings
204+
205+
Control when the invitation expires:
206+
207+
- **Flexibility**: Supports any time setting, extension, and recovery. Leave blank for permanent access
208+
- **What happens at expiration?**
209+
- Expiration is only checked when users attempt to accept the invitation
210+
- If the expiration time has passed, users cannot proceed with the invitation
211+
- Expiration check compares server current time vs. set expiration time
212+
- **Can I modify expired invitations?**
213+
- Yes, you can recover and extend expiration times by entering edit mode
214+
215+
### 3. Quota - Usage Limits
216+
217+
Set limits on how many users can accept the invitation:
218+
219+
- **When quota is exceeded:**
220+
- Operates on a first-accept, first-in basis
221+
- Users beyond the quota cannot join, even with a valid invitation link
222+
- **Recovery options:**
223+
- If quota is reached, you can increase the quota to restore access
224+
- Admin console provides real-time usage monitoring
225+
226+
### 4. Teams - Team Assignment List
227+
228+
Specify which teams invited users will join:
229+
230+
- **Team Selection**: Choose from available teams via dropdown menu
231+
- **Multiple Teams**: You can assign users to multiple teams
232+
- **No Teams Available**: If your organization has no teams, [create them](https://docs.layer5.io/cloud/identity/teams/) first. Users will be added to all successfully configured teams
233+
234+
{{< alert type="info" title="Team Structure Changes" >}}
235+
**During Organization Restructuring:**
236+
- If team structure changes after invitations are sent
237+
- Some teams may be merged or deleted
238+
- New users can still join remaining valid teams
239+
240+
**Permission Management Updates:**
241+
- Team permission policies may change
242+
- Some teams might close to new users
243+
- Other teams continue accepting new members normally
244+
{{< /alert >}}
245+
246+
### 5. Status - Enabled/Disabled
247+
248+
Control invitation accessibility:
249+
250+
- **Enabled**: Invitation functions normally
251+
- **Disabled**: If users open a disabled invitation link, they can choose to "Retry" or "Go to Dashboard"
252+
253+
{{< alert type="info" title="Invitation Idempotency" >}}
254+
Users only need to accept one invitation, regardless of how many invitation emails they receive. Once accepted, additional invitations to the same user are automatically ignored.
255+
{{< /alert >}}

0 commit comments

Comments
 (0)