> ## Documentation Index
> Fetch the complete documentation index at: https://thehyperstack.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Sakai Integration

> Issue a credential automatically when a learner reaches a Hyperstack item in Sakai.

Hyperstack connects to Sakai (20.3 and later) through **LTI 1.3** with Dynamic Registration.

## Before you start

* A [credential group](https://thehyperstack.com/docs/tutorials/credential-setup/creating-credential-group.md) with its design.
* Administrator access in Hyperstack.
* A Sakai administrator.

## Step 1: register Hyperstack in Sakai

1. In Hyperstack, click **Add integration**, then **Sakai**, then **Integrate**. Copy the **Registration URL**.
2. In Sakai's **Administration Workspace**, open **External Tools**, start an **LTI Advantage** tool with **Dynamic Registration**, and paste the URL.
3. Allow the tool to receive names and emails, and make it available to the sites that need it.

No Dynamic Registration? Use **Register by hand** on the setup page: paste Hyperstack's URLs into Sakai, then enter the values Sakai shows.

![The Set up Sakai page in Hyperstack with the registration URL and the manual form](https://mintcdn.com/hyperstack/EIbfa9XdtrmoDtnK/images/sakai-setup.webp?fit=max\&auto=format\&n=EIbfa9XdtrmoDtnK\&q=85\&s=c6b3841f03f8c5481b4701c8bb150e85)

## Step 2: add Hyperstack to a site

Teachers add Hyperstack in **Lessons** (or as an external tool), choose a credential group, and place it where learners finish.

## Who gets a credential

| Role in the course | Sees | Gets a credential |
| - | - | - |
| Learner / student | Their credential | Yes, once per credential group |
| Teacher, course designer, LMS admin | The page to pick or change the credential group | No |
| Teaching assistant, observer, parent, guest | "Nothing to issue" | No |

Test with a student account (or your LMS's "act as user"). Teacher and admin accounts never get a credential, and preview modes such as Canvas **Student View** have no real email.

## What learners see

* **Well done**: their credential is ready, with **View my credential**. It is published at once and emailed to them. Opening the item again shows the same credential, never a second one.
* **Email address needed**: the LMS didn't share their email, so nothing was issued. Ask your LMS admin to share names and emails with Hyperstack.
* **Not set up yet**: the item isn't linked to a credential group. A teacher opens it and picks one.

## Troubleshooting

Every launch is on the **Logs** tab of the setup page in Hyperstack for 90 days, with what happened and why.

| What you see | Why | What to do |
| - | - | - |
| "Hyperstack is not set up for this LMS yet" | The LMS isn't registered in Hyperstack, or the registration is switched off | Finish the setup above, and check **Registrations** on the setup page |
| "Connect this LMS to Hyperstack" | The install isn't connected to your organization yet | An LMS admin types a connection code from the setup page (codes last 30 minutes) |
| "Open Hyperstack in a new window" | The browser blocks sign-in inside the course page (often Safari) | Click the button. It works in a window of its own |
| "This sign-in expired or was already used" | The page was open too long, or reloaded | Open the item again from the course |
| "Email address needed" | Names and emails aren't shared with Hyperstack | Turn on sharing in your LMS (see the steps above) |
| A learner got a credential too early | The item wasn't locked | Use your LMS's completion rules so the item opens only when the course is done |
| "Already connected to another Hyperstack organization" | That LMS key or site is linked to another organization | Contact Hyperstack support |

## Data and privacy

| | |
| - | - |
| Standard | 1EdTech LTI 1.3 Core and Deep Linking 2.0, OIDC login, RS256-signed messages. Our public keys: `https://api.thehyperstack.com/v1/lti/1.3/jwks` |
| Received on each launch | The LMS user ID, name, email, course roles, course ID and title, item ID and title |
| Stored | Name and email on the credential issued, the LMS and item it came from, and a launch log for 90 days |
| Not requested | Grades, rosters, submissions or other course content. Hyperstack asks for no LTI Advantage service access |
| Cookies | One sign-in cookie for 10 minutes on `api.thehyperstack.com`, or the LMS's own storage when it offers it |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.