ClassLink Permissioning Based on Users API Endpoint
ClassLink Permissioning Based on Users API Endpoint
Overview
When setting up rostering with the ClassLink API, ClassLink assigns myLexia permissions to staff based on the input in their "role" field. However, it is possible to modify a staff member's myLexia permissions.
Lexia's support for the ClassLink API uses the OneRoster v1.2 rostering standard. This article explains what these permissions are and how to add them to your ClassLink users API endpoint.
Applies to: Staff who have myLexia® administrative accounts (District Administrators in a district site, and School Administrators in a school site) who also have administrative access to ClassLink.
Why would I want to change permissions?
You may want to change permissions if you want to assign staff a role in myLexia that differs from their ClassLink role, or if you want a staff member to have read-only permissions in myLexia.
The 'role' field in ClassLink's 'users' endpoint determines a staff member's permissions in myLexia. Any staff included in the 'users' endpoint will have access to myLexia via Single Sign On (SSO). With the ClassLink API, you are able to distinguish between District Administrator, School Administrator, and Teacher roles.
The below table shows role mapping between the ClassLink API and myLexia.
ClassLink Role | Lexia Role |
|---|---|
Principal | School Administator |
Site Administrator | School Administrator |
System Administrator | School Administrator |
District Administrator | District Administrator |
Teacher | Teacher |
Counselor | None - Staff with this ClassLink role will not be imported to myLexia |
How do I add alternate and advanced permissions?
To add alternate and advanced permissions, a new object labeled metadata.lexiarole or metadata.role must be added to the ClassLink users endpoint. Once the field has been added, populate the value for the staff member that needs access beyond the default roles.
If you need assistance adding the metadata field, please contact ClassLink support.
Use the following tags in the metadata field to assign the desired access level:
DAA - District Administrator Access
DRO - District Read Only
SAA - School Administrator Access
SRO - School Read Only
CRO - Teacher/Class Read Only
C - Teacher/Class Access
You only need to add these tags for:
Staff you want to have read-only permissions in myLexia.
If you want a staff member to have a myLexia role other than the one automatically assigned by their ClassLink role.
All other staff will be assigned their role indicated in their "role" field.
For more information on the access level of each role see Roles and Permissions in myLexia.