Mettre à jour une charge utile héritée pour l’API d’approvisionnement (JSON)

Si vous utilisiez auparavant une intégration API personnalisée pour l’approvisionnement des utilisateurs, vous devez mettre à jour votre charge utile JSON pour qu’elle respecte le format mis à jour de l’API d’approvisionnement. Cette mise à jour permet d’assurer la réussite des synchronisations et la mise à jour attendue des nouveaux utilisateurs et équipes.

Remarque : L’API d’approvisionnement de Workleap prend en charge les configurations CSV et JSON. Cet article décrit uniquement les configurations basées sur le format JSON. Pour les configurations CSV, cliquez ici.

Remarque : L’API reste compatible avec les anciennes charges utiles (sauf pour le paramètre settings). Toutefois, la mise à jour est simple et rapide, et elle vous permet d’accéder aux nouvelles fonctionnalités.

Mettre à jour votre charge utile API héritée

Utilisez les tableaux ci-dessous pour convertir votre charge utile existante vers le format actuel de l’API d’approvisionnement.

`Utilisateurs`

Section héritée	Nouvelle section
`users`	`members`

Champ hérité	Nouveau champ	Remarques
id	externalMemberId	Obligatoire
language	languagePreferences	Utilisez les codes de langue (ex. : fr, en)
—	productAssignations	Obligatoire ; définit à quels produits l’utilisateur a accès ; l’accès de l’utilisateur est révoqué pour tous les produits non spécifiés dans ce champ

Remarque : Copiez tous les champs personnalisés tels quels.

`Groupes`

Section héritée	Nouvelle section
`groups`	`teams`

Champ hérité	Nouveau champ
id	externalTeamId
name	teamName

`Mappages`

Section héritée	Nouvelle section
`mappings`	`teamMappings`

Champ hérité	Nouveau champ	Remarques
groupId	externalTeamId
userId	externalMemberId
subGroupId	externalSubteamId
isMember	isMember	Inchangé
isManager	isManager	Inchangé

À propos de la section « settings »

Dans l’ancienne API, la section settingspermettait de :

Synchroniser les utilisateurs Admin (syncAdmin).
Déterminer si les nouveaux utilisateurs étaient invités (inviteNewUsers).

Dans l’API d’approvisionnement actuelle :

Il n’est plus nécessaire d’inclure syncAdmin dans la charge utile (le contexte administrateur provient de la clé API, et les paramètres d’invitation sont gérés dans la page Provisionnement des Paramètres Workleap).

Important : Si votre charge utile contient la section settings, une erreur sera renvoyée.

Exemples de charges utiles

Format hérité

{
"settings": {
"syncAdmin": "00000000-0000-0000-0000-000000000000",
"inviteNewUsers": false
},
"users": [
{
"externalMemberId": "SOME-EXTERNAL-ID",
"email": "john.doe@example.com",
"firstName": "John",
"lastName": "Doe",
"jobTitle": "Some job title",
"imageUrl": "",
"language": "English",
"Extra Custom Property": "Some custom value"
}
],
"groups": [
{
"id": "SOME-EXTERNAL-TEAM-ID-1",
"name": "Some Parent Team"
},
{
"id": "SOME-EXTERNAL-TEAM-ID-2",
"name": "Some Team"
}
],
"mappings": [
{
"groupId": "SOME-EXTERNAL-TEAM-ID-1",
"userId": "SOME-EXTERNAL-ID",
"subGroupId": null,
"isMember": false,
"isManager": true
},
{
"groupId": "SOME-EXTERNAL-TEAM-ID-1",
"userId": null,
"subGroupId": "SOME-EXTERNAL-TEAM-ID-2",
"isMember": false,
"isManager": false
}
]
}

Format actuel

{
"members": [
{
"externalMemberId": "SOME-EXTERNAL-ID",
"email": "john.doe@example.com",
"firstName": "John",
"lastName": "Doe",
"jobTitle": "Some job title",
"imageUrl": "",
"languagePreferences": ["en"],
"productAssignations": ["Officevibe"],
"Extra Custom Property": "Some custom value"
}
],
"teams": [
{
"externalTeamId": "SOME-EXTERNAL-TEAM-ID-1",
"teamName": "Business"
},
{
"externalTeamId": "SOME-EXTERNAL-TEAM-ID-2",
"teamName": "Operations"
}
],
"teamMappings": [
{
"externalTeamId": "SOME-EXTERNAL-TEAM-ID-1",
"externalMemberId": "SOME-EXTERNAL-ID",
"externalSubteamId": null,
"isMember": false,
"isManager": true
},
{
"externalTeamId": "SOME-EXTERNAL-TEAM-ID-1",
"externalMemberId": null,
"externalSubteamId": "SOME-EXTERNAL-TEAM-ID-2",
"isMember": false,
"isManager": false
}
]
}

Une fois votre charge utile mise à jour

Générez une nouvelle clé API.
Définissez vos seuils de risque.