Setting up Single Sign-On (SSO) using SAML 2.0 allows students and educators to securely access the MasteryPrep platform using their existing credentials from your organization's Identity Provider (IdP), such as Google Authentication or RapidIdentity.
Here, you can review all single sign-on options that MasteryPrep supports.
How to Set Up SSO with SAML 2.0
Follow these steps to configure SSO with SAML 2.0 for your MasteryPrep account:
1. Create a Custom SAML App
To start the process, open the admin section of your Identity Provider (IdP) and create a new custom SAML app.
- Create a custom SAML app: This app will serve as the bridge between your IdP and the MasteryPrep platform.
- Add the Icon: To make the new SAML app easier to identify within your system, associate it with the MasteryPrep icon. Click Download to save the icon to your computer.
-
Enter Service Provider (SP) Information: Fill in the following fields in your SAML app configuration:
-
ACS URL: This is the Assertion Consumer Service (ACS) URL, which handles SAML authentication requests. Use the following URL:
https://us-central1-mp-ready-production.cloudfunctions.net/api-passport/login/sso/callback?id=[DISTRICTID] - Entity ID: This is a unique identifier for the service provider. Enter readyplatform.
- Name ID Format: Select email as the format for the Name ID.
- Name ID: Set this to Basic Information -> Primary email to ensure email-based authentication.
-
ACS URL: This is the Assertion Consumer Service (ACS) URL, which handles SAML authentication requests. Use the following URL:
Leave any additional fields or settings at their default values. Once the fields are completed, click Continue to proceed to the next step.
2. Enter the SAML Certificate
The next step is to configure your SAML certificate, which will be used to validate your organization's identity.
- Upload the XML File: Upload the XML metadata file from your Identity Provider. This file will automatically populate the necessary fields once your click Import.
Note: You can enter the information manually if you don't have an XML file.
- Endpoint URL: Enter the URL from the XML file if it’s not automatically imported to the field.
- Expiry Date: Confirm the expiration date of your certificate. If it has expired or is close to expiration, update or renew it as needed.
- Certificate Key: Enter the certificate key if it's not automatically imported. This key is essential to sync the data for the single sing-on.
Once all fields are populated, click Validate to check the certificate's validity. If everything is correct, click Continue to move forward.
3. Complete Setup
In this final step, please review all the information you've entered to ensure accuracy.
SP-Initiated Data: Suppose your organization uses SP-initiated data (when the service provider initiates the SSO process). In that case, you can customize the settings further as needed.
Once all the information has been reviewed, click Done to finalize the setup.
After Setup
Once the setup is complete, the SAML 2.0 status will be marked as Active. You can now:
- View Certificate: Check the certificate information and verify the current status.
- Update Certificate: If your certificate is nearing expiration or needs renewal, upload a new XML file.
- View SP-Initiated Data: Access and review the settings for SP-initiated SSO processes.
- Deactivate: If required, you can deactivate the SAML 2.0 configuration anytime.
Completing these steps ensures secure, seamless access to the MasteryPrep platform through Single Sign-On (SSO), reducing the need for students and educators to manage multiple login credentials.