Modifications apportées aux API dans la version d’août 2026 de Adobe Learning Manager

API d’administration des groupes d’utilisateurs dans Adobe Learning Manager

Cette version ajoute trois nouveaux points d’entrée API publics de portée administrateur pour gérer par programme des groupes d’utilisateurs personnalisés. Vous pouvez créer, renommer et supprimer des groupes d’utilisateurs personnalisés sans utiliser l’application d’administration, ce qui vous permet d’automatiser la gestion des groupes dans le cadre de vos workflows d’identité ou d’approvisionnement.

Ces points de terminaison fonctionnent uniquement avec des groupes d’utilisateurs personnalisés. Les groupes gérés par le système, tels que le groupe Tous les utilisateurs et les groupes d’utilisateurs générés automatiquement, ont la valeur readOnly : true dans la réponse de l’API et ne peuvent pas être modifiés ou supprimés via ces points de terminaison.

Pour connaître les exigences d’authentification d’API, voir Authentification d’API Adobe Learning Manager.

Groupes d’utilisateurs points de terminaison d’API

Les trois points de terminaison nécessitent un jeton d’accès administrateur avec des autorisations d’écriture (ROLE_ADMIN).

En-têtes de demande courants

Les trois points de terminaison nécessitent les en-têtes suivants.

Authorization: Bearer \<access-token\>
X-acap-user: \<user-id\>
X-acap-account: \<account-id\>
X-acap-caller-role: ROLE_ADMIN
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Créer un groupe d’utilisateurs

POST /primeapi/v2/userGroups

Crée un nouveau groupe d’utilisateurs personnalisé avec une liste initiale de membres. Le groupe est immédiatement disponible dans l’application d’administration.

Corps de la demande

{
  "name": "Marketing Team",
  "description": "Custom user group for marketing onboarding",
  "data": [
    { "type": "user", "id": "11282373" },
    { "type": "user", "id": "11282374" }
  ]
}

Paramètres de demande

Remarque : le tableau de données est utilisé uniquement lors de la création pour définir la liste de membres initiale. Pour ajouter ou supprimer des membres après la création, utilisez les points de terminaison d’appartenance de groupe d’utilisateurs existants.

Réponse 201 Créée

{
  "links": {
    "self": "https://<host>/primeapi/v2/userGroups"
  },
  "data": {
    "id": "2769204",
    "type": "userGroup",
    "attributes": {
      "dateCreated": "2026-06-04T14:19:53.000Z",
      "description": "Custom user group for marketing onboarding",
      "name": "Marketing Team",
      "readOnly": false,
      "userCount": 2
    }
  }
}

Mot de POST des règles de validation

Mettre à jour un groupe d’utilisateurs

PUT /primeapi/v2/userGroups/{id}

Met à jour le nom et/ou la description d’un groupe d’utilisateurs personnalisé existant. Ce point de terminaison ne peut pas ajouter ou supprimer des membres du groupe.

L’un ou l’autre champ peut être omis ; l’omission d’un champ ne modifie pas sa valeur actuelle. La transmission de la valeur NULL pour la description efface ce champ. La transmission d’une chaîne vide pour le nom est rejetée.

Corps de la demande

{
  "name": "Updated Group Name",
  "description": "Updated description text"
}

Paramètres de demande

Réponse 200 OK

{
  "data": {
    "type": "userGroup",
    "id": "2767870",
    "attributes": {
      "name": "Updated Group Name",
      "description": "Updated description text",
      "readOnly": false,
      "state": "Active",
      "userCount": 3
    }
  }
}

Mot de PUT des règles de validation

Supprimer un groupe d’utilisateurs

DELETE /primeapi/v2/userGroups/{id}

Marque le groupe d’utilisateurs personnalisé spécifié comme supprimé. L’enregistrement de groupe n’est pas définitivement supprimé : son état est défini sur SUPPRIMÉ, ce qui le rend invisible dans l’application d’administration et inéligible pour une utilisation dans les nouvelles configurations. Impossible de réutiliser l’ID de groupe.

Exemple de demande

DELETE /primeapi/v2/userGroups/2767870
Authorization: Bearer <access-token>
X-acap-user: <user-id>
X-acap-account: <account-id>
X-acap-caller-role: ROLE_ADMIN

Réponse 204 Aucun Contenu

Le corps de la réponse est vide.

Remarque : le DELETE n’est pas idempotent. L’envoi d’une deuxième demande de DELETE au même ID de groupe renvoie une erreur 400 avec le code DELETED_USERGROUP — et non 204. Considérez une réponse 400 DELETED_USERGROUP comme une confirmation que le groupe est déjà supprimé. La suppression en bloc n’est pas prise en charge ; chaque groupe nécessite une demande de DELETE distincte.

Mot de DELETE des règles de validation

API d’apprentissage externe dans Adobe Learning Manager

Cette version ajoute cinq nouveaux points d’entrée API de portée élève pour la fonctionnalité Apprentissage externe. Ces points de terminaison permettent aux élèves de créer, récupérer et mettre à jour des envois d’apprentissage externes par programme, par exemple, à partir d’une application mobile, d’un système de RH intégré ou d’un portail d’apprentissage personnalisé.

Le workflow d’apprentissage externe via l’API reflète le workflow dans l’application de l’élève : un élève soumet les détails de la formation et un document de preuve facultatif, son responsable direct reçoit une notification pour examiner la soumission et, lors de l’approbation, l’enregistrement apparaît dans le relevé de notes de l’élève.

Les cinq points d’entrée ont une portée d’élève. Un élève ne peut accéder qu’à ses propres envois : l’API renvoie une erreur si un élève tente d’accéder aux données d’un autre élève.

Pour connaître les exigences d’authentification d’API, voir Authentification d’API Adobe Learning Manager.

Points de terminaison d’API d’apprentissage externe

Tous les points de terminaison nécessitent un jeton d’accès d’élève (ROLE_LEARNER).

En-têtes de requête courants

Authorization: Bearer <access-token>
X-acap-user: <user-id>
X-acap-account: <account-id>
X-acap-caller-role: ROLE_LEARNER
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json (POST and PUT only)

Cycle de vie du statut de la soumission

APPROUVÉ et REJETÉ sont des états finaux. Une soumission rejetée ne peut pas être rouverte ; l’élève doit créer une nouvelle soumission.

Récupérer la configuration du formulaire de compte

GET /primeapi/v2/externalLearningSettings

Renvoie la configuration du formulaire au niveau du compte. Appelez ce point de terminaison avant de rendre un formulaire d’envoi. La réponse définit les champs à afficher, ceux qui sont obligatoires, leurs types de données et tous les champs personnalisés configurés par l’administrateur.

Vérifiez l’attribut activé de niveau supérieur avant de continuer. Si la valeur est false, la fonctionnalité Apprentissage externe n’est pas active pour ce compte et les points d’entrée d’envoi renvoient des erreurs.

Réponse 200 OK

{
  "data": {
    "id": "8627",
    "type": "externalLearningSettings",
    "attributes": {
      "enabled": true,
      "updatedAt": "2026-06-05T06:51:20.000Z",
      "coreFields": [
        { "id": "title", "type": "TEXT", "mandatory": true, "editable": false, "order": 0 },
        { "id": "description_notes", "type": "TEXT", "mandatory": false, "editable": true, "order": 1 },
        { "id": "date", "type": "TIMESTAMP", "mandatory": false, "editable": true, "order": 2 },
        { "id": "score", "type": "NUMBER", "mandatory": true, "editable": true, "order": 3 },
        { "id": "duration", "type": "TEXT", "mandatory": false, "editable": true, "order": 4 },
        { "id": "attachments", "type": "FILE_UPLOAD", "mandatory": true, "editable": true, "order": 5 }
      ],
      "customFields": [
        {
          "id": "960369b2-...",
          "type": "NUMBER",
          "mandatory": true,
          "order": 0,
          "label": { "en_US": "Employee Code" }
        },
        {
          "id": "3c6cc6d9-...",
          "type": "DROPDOWN",
          "mandatory": true,
          "order": 1,
          "label": { "en_US": "Department" },
          "options": [
            { "option_id": "opt_1", "label": { "en_US": "IT" } },
            { "option_id": "opt_2", "label": { "en_US": "HR" } },
            { "option_id": "opt_3", "label": { "en_US": "FIN" } }
          ]
        }
      ]
    }
  }
}

Référence du champ de base

Les champs personnalisés sont définis par l’administrateur et renvoyés dans customFields[]. Leurs ID, types, indicateurs obligatoires, étiquettes et options de liste déroulante varient selon la configuration du compte.

Lister les soumissions

GET /primeapi/v2/externalLearnings

Renvoie une liste paginée des propres envois de l’élève authentifié, triés par ordre décroissant (modifié en dernier).

Paramètres de requête

Réponse 200 OK

{
  "links": {
    "next": "/primeapi/v2/externalLearnings?page[offset]=10&page[limit]=10"
  },
  "data": [
    { "id": "1001", "type": "externalLearning", "attributes": { "status": "PENDING", ... } },
    { "id": "1002", "type": "externalLearning", "attributes": { "status": "APPROVED", ... } }
  ]
}

Récupérer une soumission

GET /primeapi/v2/externalLearnings/{id}

Renvoie l’enregistrement complet d’une seule soumission appartenant à l’élève authentifié.

**Réponse 200 OK

{
  "data": {
    "id": "1001",
    "type": "externalLearning",
    "attributes": {
      "submissionUrl": "https://<cdn-url>/cert.pdf",
      "title": "Java Fundamentals Certification",
      "status": "PENDING",
      "creationSource": "LEARNER",
      "createdAt": "2026-04-14T08:30:00.000Z",
      "modifiedAt": "2026-04-16T11:45:00.000Z",
      "fields": [ "...resolved against live settings..." ]
    },
    "relationships": {
      "reviewerUser": { "data": null }
    }
  }
}

Création d’une soumission

POST /primeapi/v2/externalLearnings

Crée une nouvelle soumission d’apprentissage externe à l’état EN ATTENTE. Tous les champs obligatoires définis dans les paramètres du compte doivent être inclus. Après la réussite d’un POST, le responsable de l’élève reçoit une notification sur la plateforme pour examiner l’envoi.

Chargement de fichier

Le champ Pièces jointes est traité séparément des autres champs. Ne l’incluez pas dans les champs[]. Au lieu de cela :

​1. Obtenez une URL de téléchargement S3 présignée à partir du point de terminaison de téléchargement de fichiers ALM.

​2. Chargez le fichier sur cette URL.

​3. Transmettez l’URL obtenue en tant qu’attribut submissionUrl de niveau supérieur dans votre demande de POST.

Corps de la demande

{
  "data": {
    "type": "externalLearning",
    "attributes": {
      "submissionUrl": "<pre-signed-upload-url>",
      "fields": [
        { "id": "title", "type": "TEXT", "value": "Java Fundamentals Certification" },
        { "id": "description_notes", "type": "TEXT", "value": "Completed via online course platform." },
        { "id": "date", "type": "TIMESTAMP", "value": { "start_date": "2026-05-01T00:00:00.000Z", "end_date": "2026-05-15T00:00:00.000Z" } },
        { "id": "score", "type": "NUMBER", "value": { "achieved_score": 88, "max_score": 100 } },
        { "id": "duration", "type": "TEXT", "value": "40 hours" },
        { "id": "960369b2-...", "type": "NUMBER", "value": "1225" },
        { "id": "3c6cc6d9-...", "type": "DROPDOWN", "value": "opt_3" }
      ]
    }
  }
}

Formes de valeur de champ

Mot de POST des règles de validation

Mise à jour d’une soumission

PUT /primeapi/v2/externalLearnings/{id}

Met à jour une soumission EN ATTENTE existante. Seules les soumissions EN ATTENTE peuvent être mises à jour. Tenter de mettre en PUT une soumission APPROUVÉE ou REJETÉE renvoie une erreur 409.

Ce point de terminaison utilise la sémantique de remplacement complet. Fournissez le tableau de champs [] complet dans chaque demande de PUT, pas seulement les champs que vous modifiez. Les champs omis du tableau sont effacés.

Champs que l’élève peut mettre à jour

Corps de la demande

{
  "data": {
    "type": "externalLearning",
    "attributes": {
      "submissionUrl": "<cdn-url>/cert-v2.pdf",
      "fields": [
        { "id": "title", "type": "TEXT", "value": "Java Fundamentals — Updated" },
        { "id": "description_notes", "type": "TEXT", "value": "Updated notes." },
        { "id": "date", "type": "TIMESTAMP", "value": { "start_date": null, "end_date": null } },
        { "id": "score", "type": "NUMBER", "value": { "achieved_score": 92, "max_score": 100 } },
        { "id": "duration", "type": "TEXT", "value": "42 hours" },
        { "id": "960369b2-...", "type": "NUMBER", "value": "1227" },
        { "id": "3c6cc6d9-...", "type": "DROPDOWN", "value": "opt_2" }
      ]
    }
  }
}

API pour ID de certification pertinent pour l’élève et ID de certification racine dans LT

Lorsqu’une certification récurrente est renouvelée, Adobe Learning Manager crée une nouvelle version de la certification et y inscrit automatiquement les élèves actifs. Si votre intégration demande des données de certification directement plutôt que de compter sur l’expérience de l’élève Adobe Learning Manager, vous pouvez utiliser cette API pour déterminer exactement quelle version d’une certification récurrente est pertinente pour un élève spécifique à tout moment.

Objectif de l’API

Les certifications récurrentes génèrent un nouvel ID de certification à chaque renouvellement. Dans l’expérience d’élève Adobe Learning Manager native, seule la version adaptée à chaque élève est affichée. Les anciennes versions sont masquées automatiquement lorsqu’un élève passe à une nouvelle version.

Si votre intégration récupère les données de certification indépendamment, par exemple pour afficher les informations de certification sur un portail externe, il se peut qu’elle n’applique pas automatiquement ce filtrage. Sans cela, un élève pourrait voir chaque version historique d’une certification récurrente, y compris celles qui ne le concernent plus, sans indication sur laquelle agir.

Cette API a comblé cette lacune. Étant donné l’ID de certification racine, il renvoie la version de certification spécifique qui s’applique à un élève donné, en tenant compte de son historique d’inscription et de toutes les récurrences.

Comprendre la périodicité de la certification

Lorsqu’une certification est configurée pour se reproduire, chaque renouvellement crée une nouvelle version de certification avec son propre ID unique. Toutes les versions remontent à un seul ID de certification racine, l’ID de la certification d’origine lors de sa création.

Par exemple, une certification qui se répète tous les mois peut produire une séquence de versions dans le temps, où chaque nouvelle version est générée automatiquement lorsque l’intervalle de périodicité est atteint. Les élèves qui sont activement inscrits lorsqu’une périodicité se produit sont automatiquement inscrits à la nouvelle version.

Étant donné que chaque version a un ID distinct, la version pertinente d’un élève dépend de son calendrier d’inscription individuel :

Détermination de la version de certification appropriée

Utilisez l’API de version de certification pour identifier la version d’une certification récurrente pertinente pour un élève spécifique.

Fournissez l’ID de certification racine comme entrée. L’API évalue l’historique d’inscription de l’élève et renvoie la version appropriée en fonction des règles suivantes :

Cela signifie que deux élèves qui interrogent le même ID de certification racine en même temps peuvent recevoir des résultats différents, en fonction de l’historique d’inscription individuel de chaque élève.

Remarque : il peut y avoir une brève fenêtre au cours d’une périodicité, pendant la création de la nouvelle version et la migration des inscriptions, pendant laquelle l’API peut retourner la version qui est sur le point d’être remplacée plutôt que la nouvelle version créée.

Exemple

Considérez une certification qui se répète tous les mois, où quatre versions ont été créées au fil du temps en raison de récurrences successives :

Cela permet à l’intégration d’orienter toujours un élève vers la version de certification qui le concerne, plutôt que d’afficher chaque version historique ou de deviner laquelle s’applique.

Référence des API

Obtenir la certification applicable pour une certification racine

GET /primeapi/v2/learningObjects/{loId}/applicableCertification

Résout la version de certification qui s’applique à l’élève actuel, en fonction de l’ID d’une certification racine. Pour les élèves inscrits, cette option renvoie la version dans laquelle ils sont actuellement inscrits. Pour les élèves qui ne sont pas inscrits, cette option renvoie la dernière version active.

Remarque : cette API renvoie des informations de version pour un seul élève à la fois. Elle ne renvoie pas la liste de toutes les versions d’une certification.

Paramètres de chemin

Paramètres de requête

Exemple de requête

GET /primeapi/v2/learningObjects/certification%3A167658/applicableCertification?include=subLOs
Accept: application/vnd.api+json
Authorization: oauth <access-token>

curl -X GET --header 'Accept: application/vnd.api+json' \
--header 'Authorization: oauth <access-token>' \
'https://<host>/primeapi/v2/learningObjects/certification%3A167658/applicableCertification?include=subLOs'

Remarque : la valeur loId doit être codée en URL. Le signe deux-points dans un ID de certification tel que certification:167658 est codé en tant que %3A.

Exemple de réponse 200 OK

La réponse utilise la même structure qu’une réponse d’objet d’apprentissage standard, renvoyant la certification résolue.

Important : le champ d’ID dans la réponse est l’ID de la certification résolu, la version spécifique applicable à cet élève. Il sera généralement différent de l’ID de certification racine que vous avez transmis en tant que loId, puisque l’objectif de cette API est de traduire un ID racine dans la version actuelle correcte.

{
  "data": {
    "id": "string",
    "type": "string",
    "attributes": {
      "authorNames": [
        "string"
      ],
      "bannerUrl": "string",
      "catalogs": [
        ...
      ]
    }
  }
}

Codes de réponse

Exemple de réponse à l’erreur

{
  "meta": {
    "error": "string",
    "detail": "string"
  }
}

Remarque : cette API résout la version pour un élève par appel. Elle ne renvoie pas la liste de toutes les versions qui existent pour une certification racine.

Points importants

Remarque : un équivalent de portée administrateur de cette API n’est pas disponible actuellement et est en cours d’évaluation pour une prochaine version.

Utiliser cette API dans votre intégration

Un cas d’utilisation courant est une page ou un portail externe qui répertorie les certifications auxquelles un élève peut accéder. Plutôt que de créer un lien direct vers un ID de certification spécifique, qui peut devenir obsolète après une périodicité. Créez un lien à l’aide de l’ID de certification racine et résolvez la version correcte au moment où l’élève la sélectionne.

​1. Stockez ou référencez des certifications dans votre intégration à l’aide de l’ID de certification racine, l’ID de la certification telle qu’elle a été créée au départ, avant toute périodicité.

​2. Lorsqu’un élève sélectionne une certification pour l’afficher ou l’utiliser, appelez GET /primeapi/v2/learningObjects/{loId}/applicableCertification, en transmettant l’ID de certification racine loId.

​3. Utilisez la version de certification renvoyée dans la réponse pour diriger l’élève vers la destination correcte, qu’il s’agisse d’une action d’inscription ou d’une vue de la progression actuelle.

Cela garantit que les élèves obtiennent toujours la version de la certification qui correspond à leur inscription et à leur progression réelles, même si la certification se reproduit au fil du temps et génère de nouvelles versions.

Rapport : ID de formation racine dans le relevé de notes de l’élève

La colonne ID de formation racine est disponible par défaut dans le relevé de notes de l’élève pour tous les comptes.

Remarque : pour les comptes très volumineux avec un volume élevé de certifications, les valeurs d’ID de formation racine dans le relevé de notes de l’élève sont résolues par lots. Cela ne modifie pas l’exactitude des données, mais la génération de transcriptions très volumineuses peut prendre plus de temps.

Cette colonne vous permet de regrouper et de générer des rapports sur l’historique complet d’un élève pour chaque version d’une certification périodique, plutôt que de traiter chaque périodicité comme un enregistrement indépendant et sans rapport. Chaque périodicité apparaît toujours comme sa propre ligne dans le relevé de notes de l’élève. La colonne ID de formation racine identifie simplement les lignes appartenant à la même certification sous-jacente.

Remarque : utilisez la colonne ID de formation racine pour suivre l’historique complet de participation d’un élève tout au long d’une certification récurrente.