Adding group with SAML

 Steps to Configure SAML Integration on the
Studio Platform:
  • Login as Administrator
  • Access the Studio platform using your administrator credentials.

  • Create a Customer Group:
  • Navigate to the Customer tab.

  • Click on the +Group option.

  • Fill in the metadata, ensuring that the Client Group ID is unique and does not start with the word “SAML” (must be alphanumeric).

  • Set Up SSO Source:
  • The Kitaboo Support team will share the Service Provider (SP) .xml file consisting of the Reply URL and the Identifier, i.e. the entity ID.
  • Select SSO Source as “SAML”.
  • Enter the SAML data obtained from the partner school/district, including:

    • IDP URL

    • BASE URL

    • Issuer ID

    • Certificate URL

    • Encrypted Response – Enable/Disable/None

    • Signed Request – Enable/Disable/None

    • Canonicalization Algorithm

    • Signature Algorithm

  •  Now select on the Rostering Type dropdown and select OneRoster or
  • OneRoster 1.2 and accordingly fill up the details for the Rostering type.
  • Add the Group:
  • Once all the required data is correctly filled, click the Add button.

  • Sync Data:
  • Return to the Customer tab.

  • Filter the data by Group and select the recently created district from the list.

  • Click on Sync all data-API. To track the synchronization status, check the Status option.

  • Generate Licenses:
  • After the data is properly synced, you can generate licenses for specific schools by clicking on the Issue License.

  • Distribute Content:
  • District/School administrators can now log in and distribute content to users.

District Guide:

  • Login as District Administrator
  • Access the Studio platform using your district administrator credentials.

  • Select School Account:
  • Select the school from the top right corner.

  • Assign Content:
  • Navigate to the Distribute Content tab.

  • Click on User or Class to distribute the respective content.

  • Select the users and Order ID.

  • Click on the Distribute button.

  • Revoke Content:
  • Navigate to the Users tab.

  • Select the user or class from which you want to revoke the content.

District/School FAQ:

Q1: Can district/school admins add new users or classes directly in Studio?

No, as it’s a SAML sync, user creation and updates need to be done via API/SFTP/ZIP. You must request the main admin to resync the data in Kitaboo so that the district admin can see the latest roster changes.

 

Q2: Can district/school admins set/reset passwords for users in Studio?

No, As SSO is done using SAML

 

Q3: Can district admins delete users/classes using Studio?

Yes, but whenever an auto sync occurs, the users and classes will be recreated.

 

Q4: Can district/school admins assign content to users beyond the license limit?

No, they can only distribute content within the limits allocated by the main admin. If additional licenses are needed, they should reach out to the main admin to increase the license count.

 

Q5: Can district admins control the license count school-wise?

Yes, district admins can manage license counts from the “Distribute Content” tab by selecting the title from the order and managing it under the “More” section.

 

API Endpoints Used

  • OneRoster 1.1 
  • /ims/oneroster/v1p1/orgs

  • /ims/oneroster/v1p1/schools/{schoolSourceid}/classes

  • /ims/oneroster/v1p1/schools/{schoolSourceid}/students

  • /ims/oneroster/v1p1/schools/{schoolSourceid}/teachers

  • /ims/oneroster/v1p1/schools/{schoolSourceid}/enrollments

OneRoster 1.2

  • /ims/oneroster/rostering/v1p2/schools

  • /ims/oneroster/rostering/v1p2/schools/{schoolSourceid}/classes

  • /ims/oneroster/rostering/v1p2/schools/{schoolSourceid}/students

  • /ims/oneroster/rostering/v1p2/schools/{schoolSourceid}/teachers

/ims/oneroster/rostering/v1p2/schools/{schoolSourceid}/enrollments

Signing in with SAML:

Learn how to sign in to Kitaboo Player with SAML (Sample flow.)

Note: How you sign in depends on how your administrator has set up access

1. Go to KitabooPlayer  URL: https://player.kitaboo.com/

2. Click “Sign in with SAML”

 

3. After successful login users can access the content .