Skip to content

Commit d2a1e76

Browse files
authored
Merge pull request #823 from Vincamine/w-learner-status
Updated Academy Learner Status
2 parents fb707fd + 4b5ac05 commit d2a1e76

1 file changed

Lines changed: 31 additions & 1 deletion

File tree

content/en/cloud/security/roles/academy-roles.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ tags: [academy, roles]
4646

4747
{{< cardpane >}}
4848
{{% card header="Learner" %}}
49+
Learner = A [User](../roles/user-role.md) who has registered for academy content.
4950
<img src="/cloud/security/images/learner.svg" link="images/learner.svg" width="100%" alt="Learner Roles" />
5051
{{% /card %}}
5152
{{< /cardpane >}}
@@ -84,5 +85,34 @@ While the maximum number of instances is unlimited, the available seats for Lear
8485

8586
- Check [Permissions Reference](/cloud/reference/default-permissions/)
8687

88+
**Status as a Learner**
89+
90+
A learner in the academy system has two types of status that work together:
91+
92+
1. **[User](../roles/user-role.md) Account Status**
93+
- **Active**: Can log in and access academy, register for new courses, continue existing courses
94+
- **Inactive**: Account is disabled/deleted
95+
96+
2. **Academy Registration Status** - Progress in specific content
97+
98+
| Status | What it means |
99+
|-------------|-------------|
100+
| registered | They signed up but haven't started |
101+
| completed | They finished the course |
102+
| failed | They didn't pass |
103+
| withdrawn | They left the course |
104+
105+
**What this means:**
106+
1. Active User + Registered = Ready to start learning
107+
2. Active User + Completed = Finished, show achievements
108+
3. Active User + Failed/Withdrawn = May need re-enrollment
109+
4. Inactive User + Any Status = No academy access (show login prompt)
110+
111+
**Reference:** See the complete [Academy Registration Status schema](https://github.com/meshery/schemas/blob/master/models/v1beta1/academy/academy.go#L16) for technical implementation details.
112+
87113
{{% /card %}}
88-
{{< /cardpane >}}
114+
{{< /cardpane >}}
115+
116+
{{< alert title="API Limitation" color="warning" >}}
117+
The current API only returns registrations with "registered" status. We do not currently retrieve completed, failed, or withdrawn registrations through standard endpoints.
118+
{{< /alert >}}

0 commit comments

Comments
 (0)