# LTI1.3 / Advantage

Use this guide if your LMS supports **LTI 1.3 /** **Advantage**.

### Configure LTI 1.3 in Synap

#### Step 1. In Synap, go to Portal Settings > Authentication

You must be logged in as an admin to see this page.

Your organisation must also have **Single Sign-On (SSO)** in your subscription plan to set up LTI.

<div align="left"><figure><img src="/files/FIqHK98KJOw3Ao8QLkSs" alt=""><figcaption></figcaption></figure></div>

<figure><img src="/files/T0LKuN0CmrNlGTU3wwLK" alt=""><figcaption></figcaption></figure>

#### Step 2. Click "Add new configuration"

Select **LTI 1.3**.

<figure><img src="/files/sx4Dkwkl0i4oRFmx44tY" alt=""><figcaption></figcaption></figure>

#### Step 3. Fill in the form

* **Name (required):** Enter a description such as "LTI with LMS". This is only for record keeping. Students will not see it.
* Label: Leave this blank.
* **Registration:** Keep this checked. Otherwise, you must import users into Synap before they launch through LTI.

The remaining fields such as *Issuer, Client ID, etc* will be provided by your platform when registering Synap as an LTI 1.3 tool. In most cases you can provide the Tool JWKS URL, Tool Login URL and Tool Redirect URL manually by copying the values shown on this screen, and then filling out the remaining form based on the values created by your platform.

{% hint style="info" %}
**Are you integrating with Blackboard?** \
\
You can save time by using the "Register LTI1.3/Advantage Tool" option in your Blackboard Administrator Tools -> LTI Tool Providers page. \
\
Enter the Client ID `a1ddd88e-a5d5-439e-b81e-292a06030197` and press Submit to automatically register Synap into your instance. You will see a few a page to "Modify LTI 1.3 Tool: Synap". Make a note of "Default Deployment ID" which you will need below.\
\
Tool Provider Custom Parameters should be left blank.\
\
**Institution Policies**\
**- User Fields to Send:** We require enabling "Role in Course" and "Name" at a minimum. "Email Address" is also highly recommended.\
\- **Allow grade service access:** Needed for Advanced Grading Service (score postback).\
\- **Allow Membership Service:** Not explicitly required as membership access is normally determined on a per-user basic using the "Role in Course" claims per launch. \
\
\
To complete the integration paste the following into the form in Synap:\
\- Issuer: `https://blackboard.com`\
\- Client ID: `a1ddd88e-a5d5-439e-b81e-292a06030197`\
\- Deployment ID: *Shown as "Default Deployment ID" in the registration step in Blackboard*\
*-* Platform JWKS URL: `https://developer.blackboard.com/.well-known/jwks.json`\
\- Platform OIDC Auth URL: `https://developer.blackboard.com/api/v1/gateway/oidcauth`\
\- Platform Auth Token URL: `https://developer.blackboard.com/api/v1/gateway/oauth2/jwttoken`
{% endhint %}

Press **Save** after filling out all the required fields and close the window.

<figure><img src="/files/0l2PWFZU9D1P9XPqsgim" alt=""><figcaption></figcaption></figure>

### LTI Launch

Once your LMS has registered Synap as an LTI 1.3 Tool Provider, you will need to follow your platform's specific documentation on how to reference LTI tools in your Course / Lesson builders.

We currently support three distinct launches:<br>

* **Deep Linking:** Allows instructors to select either an Exam or a Collection as a course item that students can launch into.
* **Exam:** Launches students directly into an Exam Attempt.
* **Collection:** Launches students into a specific Collection or Collection Item where they can read notes, view videos and documents, or take practice quizzes.

{% hint style="warning" %}
**Launch: Embedding vs New Window**

With LTI you have a choice between launching Synap in a new window, or embedding within your LMS in a iframe. To get started we recommend you launch in a new window, and confirm your integration is wired up correctly. For embedding in an iframe you will need to inform your account manager as your LMS domain must be whitelisted to enable embedding. This is a a common security measure to stop unauthorised entities from embedding Synap into their UI. Once your platform domain has been whitelisted, you can switch to launching in embed / iframe mode.
{% endhint %}

{% hint style="info" %}
**Are you integrating with Blackboard?**<br>

When editing a Course you can add Synap Content by clicking "Content Market" and selecting either "Synap Collection" or "Synap Exam". This will create an LTI Deep Link launch, displaying a list of available content in your Synap Portal within a UI. Select the content you wish to link, press "Continue" and the selected content should populate in your Course.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://academy.synap.ac/doc/integrations/lti/lti1.3-advantage.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.