# Integrate ClassLink with Verkada Guest

ClassLink is a popular Identity Provider (IdP) used by school admins, teachers, and students. Verkada Guest allows you to sync your student roster information from ClassLink. This allows the use of Student Guest types, which include the following:

* Late arrival (track students who arrive late to school)
* Student pick-up (track when a student is picked up by their parent/guardian)
* Self sign-out (track when a student leaves school early)

***

## ClassLink configuration

### Integration requirements

{% stepper %}
{% step %}
**The Command user setting up the integration must be an Org Admin**
{% endstep %}

{% step %}
**The Command user’s email must match an email of a ClassLink Roster Server user in the target ClassLink tenant.**
{% endstep %}

{% step %}
**The corresponding ClassLink Roster Server user must have the role: administrator**
{% endstep %}

{% step %}
**The corresponding ClassLink Roster Server user must be associated with a ClassLink org type: district**
{% endstep %}
{% endstepper %}

If there does not exist a corresponding ClassLink Roster Server user that satisfies requirements 2-4, a ClassLink Tenant Admin can add manual records to the Roster Server.

### Add Verkada Guest to ClassLink

{% stepper %}
{% step %}
**In the ClassLink Roster Server, navigate to Apps and click ADD.**
{% endstep %}

{% step %}
**Search for "Verkada Guest" and click + Add.**
{% endstep %}

{% step %}
**In the Apps menu, toggle on Enabled for Verkada Guest.**
{% endstep %}

{% step %}
**Configure permissions for the Verkada Guest app so that the following fields are shared:**

* Collection: **Users**
  * sourcedid
  * dateLastModified
  * orgSourcedids
  * username
  * familyName
  * status
  * enabledUser
  * role
  * givenName
  * identifier
  * agentSourcedIds
  * middleName
  * email
  * phone
* Collection: **Orgs**
  * sourcedId
  * dateLastModified
  * type
  * status
  * name
    {% endstep %}
    {% endstepper %}

### Connect ClassLink in Command

{% stepper %}
{% step %}
**In Verkada Command, go to All Products > Workplace > Guest.**
{% endstep %}

{% step %}
**In the left navigation, click Guest Settings.**
{% endstep %}

{% step %}
**Under Organization, select Schools.**
{% endstep %}

{% step %}
**Click Sync students with ClassLink.**

a. Enter your Tenant ID.\
b. Select **Sync**.
{% endstep %}

{% step %}
**A confirmation email will be sent to the Command user setting up the integration. Click the link in this email to confirm the integration.**
{% endstep %}
{% endstepper %}

{% hint style="danger" %}
The [integration requirements](#h_d9bc5d61fa) must be met to complete the ClassLink integration.
{% endhint %}

***

## Command configuration

{% stepper %}
{% step %}
**In Verkada Command, go to All Products > Workplace > Guest.**
{% endstep %}

{% step %}
**In the left navigation, click Guest Settings.**
{% endstep %}

{% step %}
**Under Organization, select Schools.**
{% endstep %}

{% step %}
**Assign schools from ClassLink to Guest sites.**

<div align="left" data-with-frame="true"><img src="https://1436127735-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZyuELZr7uIcXX3WnjX0N%2Fuploads%2Fgit-blob-c852ee5554a68fdbe736532bdc31011d024d3cb5%2F4a2973a6d1c7f61506b1cc1712f575614873eb4c.png?alt=media" alt="" width="375"></div>
{% endstep %}
{% endstepper %}

A school may be assigned to one or multiple Guest sites. A Guest site can only have one school assigned to it. Only one ClassLink tenant can be paired with a Command Org. A ClassLink tenant cannot be paired with multiple Command Orgs.

***

## FAQ

<details>

<summary>How can I check which ClassLink Roster Server users are being shared with Verkada Guest?</summary>

To check which users are being shared with Verkada Guest:

From ClassLink Launchpad, navigate to Roster ServerSelect ApplicationsSelect Verkada GuestSelect Users

To review which users satisfy [requirements](https://help.verkada.com/guest/schools/integrate-classlink-with-verkada-guest) 3 and 4 for the integration with Guest:

Filter the Role column by administratorFilter School by the name of the district name in ClassLink. This name can be confirmed by navigating to the Orgs tab and finding the entry with org type: district.

</details>

<details>

<summary>What is required to associate a guardian with a student?</summary>

To associate guardians with students in ClassLink, each guardian user must have the following fields configured:

* **sourcedId** – Must be present for all guardian users
* **enabledUser** – Must be set to `true`
* **orgSourcedIds** – At least one value must be set for all guardian users
* **role** – Must be set to `guardian`
* **username** – Must be present for all guardian users
* **agentSourcedIds** – Must include the sourcedIds of the students the guardian is authorized to access. For multiple students, separate each ID with a comma (e.g., `id1,id2,id3`).

</details>

***

{% hint style="info" %}
**Prefer to see it in action?** Check out the [video tutorial](https://www.youtube.com/watch?v=WFUluswVNJ0).
{% endhint %}