Using the API to get details about the learner during the SSO process

Overview

If you are developing, or planning to develop, Single Sign-On (SSO) using Onefile as the authentication provider, you may need additional information about the user when they log in. For example, you may want to retrieve the Standards they are assigned to, or other profile and learner‑related data. This can be done using the Onefile API during the SSO process.

Once the user is authenticated via SSO, you can use an API token to call specific endpoints to retrieve the required information about the learner or user account.

User Roles

This information applies to technical teams or developers working with:

• Centre Manager
• Technical Integration Teams
• Developers implementing SSO

How It Works

The API can be used alongside the SSO authentication flow to retrieve detailed user information after successful login. The high‑level steps are:

1. User authenticates with Onefile via SSO.
2. Your system receives the SSO payload (including the Onefile User ID or SAMLID, depending on method).
3. Your system uses the API Token to call the Onefile API.
4. The relevant user details (e.g., assigned Standards, Episodes, Centre information, etc.) are returned.

Typical Endpoint Usage

After authentication, you can call the Onefile API to retrieve additional data. Example API endpoints include:

• GET /api/v2.1/User/{id} — retrieves core user information.
• GET /api/v2.1/User/{id}/LearnerEpisodes — retrieves learning episodes, including Standards.
• GET /api/v2.1/LearningAims/{id} — retrieves detailed Standard information.

Your integration logic can then use this information to tailor the user experience within your system.

The SSO + API Workflow

The diagram below represents the flow of Single Sign-On combined with an API request for additional learner data:

Tips & Notes

• Your API Token must be stored securely and never exposed in client‑side code.
• Always authenticate first, then call the API — API calls cannot replace authentication.
• If using SAML SSO, you can provision users using the SAMLID mapped through the API.
• Ensure API rate limits and caching strategies are considered in your implementation.

Terminology

The terminology used in this article may differ depending on your Centre’s configuration or the SSO method being used.

Related Articles

• SAML Integration
• Logging in with Microsoft
• API Authentication Overview

Need Help?

If you need assistance, please contact Onefile Support or your internal support team.