Ingestion de données avec l’API OneRoster

L’API OneRoster (Interfaces de programmation d’applications) est un format Standard de l’industrie, de 1EdTech (anciennement IMS Global), pour l’échange de données SIS (Student Information System) / Systèmes de gestion des étudiants (SMS). À l’aide de cette méthode de synchronisation, vous pouvez vous connecter directement à votre SIS/SMS à l’aide des API OneRoster 1.1 basées sur REST développées par votre fournisseur SIS/SMS. La prise en charge de l’API vous permet de synchroniser les données directement au lieu d’utiliser des fichiers CSV (Valeur séparée par des virgules).

Données consultées par School Data Sync

Importante

En vous connectant et en mettant à disposition des données d’établissement avec School Data Sync, vous reconnaissez être autorisé à partager ces données avec Microsoft et vous engagez à respecter les normes de gouvernance des données de votre organization.

Sessions académiques

Action	URL	Propriétés de filtre requises	Filtre facultatif/recommandé	Exemples
GetAllAcademicSessions	/academicSessions	status	Datelastmodified	/academicSessions ?offset=0&limit=5000&filter=status='active'/academicSessions ?filter=dateLastModified>'{deltaDateTime}'

Organisations

Action	URL	Propriétés de filtre requises	Filtre facultatif/recommandé	Exemples
GetAllOrgs	/orgs	status	Datelastmodified	/orgs ?offset=0&limit=5000&filter=status='active'/orgs ?filter=dateLastModified>'{deltaDateTime}'

Utilisateurs

Action	URL	Propriétés de filtre requises	Filtre facultatif/recommandé	Exemples
GetAllUsers	/Utilisateurs	status	Datelastmodified	/users ?offset=0&limit=5000&filter=status='active'/users ?filter=dateLastModified>'{deltaDateTime}'

Classes

Action	URL	Propriétés de filtre requises	Filtre facultatif/recommandé	Exemples
GetAllClasses	/Classes	status	Datelastmodified	/classes ?offset=0&limit=5000&filter=status='active'/classes ?filter=dateLastModified>'{deltaDateTime}'

Inscriptions

Action	URL	Propriétés de filtre requises	Filtre facultatif/recommandé	Exemples
GetAllEnrollments	/Inscriptions	status	Datelastmodified	/enrollments ?offset=0&limit=5000&filter=status='active'/enrollments ?filter=dateLastModified>'{deltaDateTime}'

Cours

Action	URL	Propriétés de filtre requises	Filtre facultatif/recommandé	Exemples
GetAllCourses	/Cours	status	Datelastmodified	/courses ?offset=0&limit=5000&filter=status='active'/courses ?filter=dateLastModified>'{deltaDateTime}'

Démographie

Données facultatives

Action	URL	Propriétés de filtre requises	Filtre facultatif/recommandé	Exemples
GetAllDemographics	/Démographie	status	Datelastmodified	/demographics ?offset=0&limit=5000&filter=status='active'/demographics ?filter=dateLastModified>'{deltaDateTime}'

Configurer SDS pour Microsoft 365 Éducation locataire

• locataire Microsoft 365 Éducation
• Besoin d’autorisations d’administrateur général

Accès SDS et première connexion

Pour accéder au portail Administration SDS, lancez votre navigateur web, accédez à sds.microsoft.com, puis connectez-vous à l’aide de votre compte Microsoft 365 Global Administration.

1. Sélectionnez Démarrage.

   

2. Cliquez sur Continuer.

   

   Prévoyez quelques instants pour que les services s’approvisionnent sur le locataire avant l’étape suivante.

   

3. Sélectionnez Créer un flux entrant. Sélectionnez Suivant pour continuer.

   

4. Choisissez votre source de données. Pour l’API OneRoster, sélectionnez l’option Se connecter à mes données.

5. Sélectionnez le format. Pour l’API OneRoster, vous sélectionnez l’option API. Sélectionnez Suivant pour continuer.

   

   

6. Vous devez sélectionner votre fournisseur SIS/SMS dans la liste des fournisseurs. Une fois que vous avez sélectionné, sélectionnez Suivant pour continuer.

   

   Remarque

   Si votre fournisseur SIS/SMS ne figure pas dans la liste, consultez Vue d’ensemble du fournisseur OneRoster pour obtenir des instructions sur la participation aux tests pilotes ou des informations à envoyer à votre fournisseur pour qu’il participe à être ajouté en tant que fournisseur OneRoster.

7. Pour activer la connexion à votre SIS/SMS, vous devez fournir les informations d’identification de connexion.

   • URL d’accès web : URL où votre API OneRoster est accessible pour votre SIS/SMS

   • ID client utilisé pour se connecter à votre API OneRoster SIS/SMS

   • Clé secrète client utilisée pour se connecter à votre API OneRoster SIS/SMS

   • URL du jeton d’accès : si votre API OneRoster SIS/SMS est configurée pour l’authentification à l’aide d’OAuth2, vous devez également fournir le point de terminaison URL du jeton d’accès qui sera utilisé pour la connexion. Le point de terminaison est différent de l’URL d’accès Web.

   • Sélectionnez Suivant pour continuer.

   

8. Ensuite, nous testons la connexion à votre SIS/SMS en fonction des informations entrées dans le dernier écran.

   

   • S’il n’y a pas de problème, vous êtes averti et vous pouvez sélectionner Suivant pour continuer.

   • Si nous ne parvenons pas à établir une connexion, vous êtes averti et vous serez en mesure de sélectionner Retour pour examiner et mettre à jour les informations fournies.

   

9. Choisissez votre année scolaire actuelle et indiquez un nom convivial, par exemple 2023 ou 2022 - 2023. (Les caractères doivent être utf8 ou seront automatiquement supprimés).

   Importante

   L’année scolaire est utilisée pour associer des données entrantes afin de générer des données historiques d’une année à l’autre. L’approche est alignée sur une année scolaire et une année civile. Si votre année scolaire s’étend sur une année civile, par exemple, début du 15/08/2022 et se termine le 15/06/2023, la valeur de l’année scolaire à sélectionner est l’année de fin, 2023. Pour plus d’informations, consultez Gestion de l’année scolaire

   Entrez les dates de début et de fin de votre année scolaire.

   En fonction des fonctionnalités de données facultatives prises en charge par votre fournisseur, vous voyez le bouton bascule sélectionné Sur (par défaut) pour inclure d’autres données. Vous pouvez sélectionner le bouton bascule à désactiver si vous le souhaitez. Si le bouton bascule est désactivé et que l’activation n’est pas disponible, cela signifie que le profil du fournisseur ne prend actuellement pas en charge la fourniture des données facultatives. Pour plus d’informations si votre fournisseur prend en charge l’envoi de données facultatives, consultez Vue d’ensemble du fournisseur d’API OneRoster.

   Entrez la date à laquelle SDS doit arrêter la synchronisation des données en fonction de l’année scolaire définie pour cette source. Il est le plus courant d’arrêter la synchronisation des données à la date de fin d’année scolaire que vous venez d’entrer.

   Sélectionnez Suivant pour continuer.

   

10. Sélectionnez les options de règle d’identité utilisateur. Effectuez vos sélections pour les rôles de personnel et d’étudiant.

    Remarque

    La correspondance utilisateur est effectuée avec le flux entrant et n’écrit ni ne met à jour les objets utilisateur dans Microsoft Entra ID. La correspondance est effectuée et stockée dans le lac de données Éducation. Pour plus d’informations, consultez Microsoft 365 Gérer les utilisateurs sur l’écriture du lien de correspondance avec le flux sortant.

    • Attribut de la source : attribut utilisateur basé sur les données provenant de votre SIS/SMS.
      • Les options de source disponibles sont Nom d’utilisateur et Email.
    • Attribut à mettre en correspondance : propriété utilisateur dans Microsoft Entra ID à mettre en correspondance.
      • Les options de correspondance Microsoft Entra ID disponibles sont UserPrincipalName et Mail.
    • (FACULTATIF) Si vos données utilisateur n’incluent pas la valeur @domain , sélectionnez un domaine dans la liste.

    Avertissement

    La sélection d’un domaine est facultative et ne doit être utilisée que si les données entrantes basées sur l’attribut sélectionné à partir de la source n’incluent pas la valeur @domain . SDS n’case activée pas et ne s’ajoute pas si la valeur est manquante sur un enregistrement. SDS ajoute la sélection de domaine à tous les enregistrements, ce qui peut entraîner des @domain@domain et ne pas trouver de correspondances dans ces instances pour le mappage utilisateur existant avec les utilisateurs dans Microsoft Entra ID.

    Attention

    Si les utilisateurs SIS/SMS, par exemple les utilisateurs du groupe de rôles personnel, peuvent être associés à @domain1 ou @domain2 ou @domain3 vous devez avoir un @domain inclus dans les données sources, en fonction de l’attribut sélectionné dans la sélection de la source (exemple : prefix@domain). Cela est nécessaire pour que votre attribut corresponde à : UserPrincipalName ou Mail pour trouver le bon Microsoft Entra’utilisateur avec lequel correspondre.

    La spécification de l’API OneRoster v1.1 autorise uniquement le passage d’un rôle par utilisateur. S’il est associé à plusieurs organisations, il peut uniquement passer le même rôle pour un utilisateur à plusieurs organisations. Étant donné qu’un rôle par organization les enregistrements sont marqués comme étant « True » (Valeur primaire).

    Importante

    Lors de la configuration du flux Gérer les utilisateurs de Microsoft 365, ces règles sont utilisées si l’option est activée pour Créer des utilisateurs sans correspondance, afin de définir la construction de la propriété Microsoft Entra UserPrincipalName.

    Une fois que vous êtes satisfait de vos sélections, sélectionnez Suivant pour continuer.

    

11. Examiner les informations présentées dans Vérifier et créer. Si tout semble correct, sélectionnez le bouton Suivant . Si ce n’est pas le cas, vous pouvez revenir à correct.

    

    

12. Votre flux de données entrant a été créé et la première exécution est en attente, sélectionnez le bouton Terminé . Revenez en arrière pour voir la status de votre première exécution.

    

    

    Conseil

    Vous pouvez configurer votre configuration Gérer les données immédiatement après avoir défini votre configuration de données Connect, pendant la première exécution active ou ultérieurement une fois la première exécution terminée.

13. Pour case activée sur la status de l’exécution, revenez à la page Du tableau de bord Accueil.

    S’il n’y a aucun problème avec vos données, le tableau de bord Accueil indique « Aucune erreur de données ou avertissement trouvé » et « Nous n’avons rencontré aucune erreur de données ou avertissement lors de votre dernière exécution. Poursuivez l’excellent travail !

    Si des problèmes sont détectés avec vos données, le tableau de bord Accueil indique que « Nous avons détecté des problèmes avec vos données » et vous encourage à examiner l’intégrité de la synchronisation.