API SCIM directe

Cet article explique comment utiliser des appels API manuels pour mettre à jour l’approvisionnement des utilisateurs. 

Si tu préfères une démonstration vidéo, tu peux passer directement à cette section.

Pour commencer, un administrateur IT dans Workvivo peut accéder aux paramètres d’approvisionnement via le panneau d’administration :

vous choisirez « Autre » comme fournisseur SCIM et générerez le jeton secret SCIM.

De plus, il y a quelques autres paramètres que tu peux modifier :

• Autoriser les utilisateurs à être réactivés après un appel POST
• Autoriser la modification des rôles d'authentification sur SCIM PUT. Nous recommandons de l'activer si les rôles utilisateur sont gérés via des appels SCIM. Si c'est géré depuis le panneau d'administration, laisse ce paramètre à « Non »
• Autoriser la mise à jour du mode d'authentification utilisateur. Nous recommandons de l'activer si le provisionnement est défini selon une approche hybride (les utilisateurs de Workvivo se connectent via SSO et mot de passe)

Voici nos exemples de POST, de PUT et de PATCH à titre de référence. Tu trouveras également ci-joint un exemple de collection JSON à titre de référence.

Si tu indiques à ton contact Workvivo (le responsable du projet d’intégration avant le lancement ou l'équipe d'assistance via le bouton « Soumettre une demande » après le lancement) les points de données que tu aimerais voir figurer sur chaque profil d’employé (par exemple : un champ personnalisé pour chaque désignation d’équipe supplémentaire), nous pouvons configurer cela de notre côté et fournir plus de détails sur les appels d’attributs spécifiques.

Remarques :

• S'il te plaît, veille à ce que l'ID externe soit unique par utilisateur et qu'il ne change pas.
• De plus, s'il te plaît, ne transmets pas de valeurs NULL à Workvivo. Utilise plutôt des chaînes vides ou supprime l'opération.

Exemple de demande SCIM POST :
URL de demande : https://[domaine de l’entreprise]/scim/v2/scim/Utilisateurs/
Exemple : https://company.workvivo.com/scim/v2/scim/Users/
Méthode de requête : POST (créer)

Exemple de demande :

{
    "schémas" : [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "externalId": "8715", // Identifiant unique 
    "Nom d'utilisateur" : "joe.bloggs@workvivo.com",
    "Nom d'affichage" : "Joe Bloggs",
    "nom" : {
        "formatted": "Joe Bloggs",
        "familyName": "Bloggs",
        "givenName": "Joe"
    },
    "e-mails" : [
        {
            "type": "work",
            "value": "joe.bloggs@workvivo.com",
            "primary": true
        }
    ],
    "Numéros de téléphone" : [
        {
            "primary": true,
            "type": "work",
            "value": "1234567"
        },
        {
            "primary": true,
            "type": "mobile",
            "value": "+1234567"
        }
    ],
    "adresses" : [
        {
            "locality": "Ireland", // Secondary Team
            "type": "work"
        }
    ],
    "titre" : "Assistance technique",
    "actif" : true,
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "service" : "Service client", // Équipe principale
        "Centre de coûts": "Opérations", // Équipe tertiaire
        "responsable" : {
            "displayName": "",
            "value": "654321",
            "$ref": ""
        },
        "taxonomies" : [ // Équipes supplémentaires
            {
                "displayName": "Customer Experience",
                "type": "Division"
            },
            {
                "displayName": "Workvivo",
                "type": "Company"
            }
        ]
    }
}

Exemple de requête SCIM PUT :

URL de demande : https://[domaine client]/scim/v2/scim/Utilisateurs/662096
Exemple : https://company.workvivo.com/scim/v2/scim/Users/662096

Méthode de demande : PUT (créer ou mettre à jour)

 

Demande d'échantillon :

{
    "schémas" : [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "Identifiant externe" : "8751", // Identifiant unique 
    "Nom d'utilisateur" : "Joe.bloggs2@workvivo.com",
    "nom" : {
        "formatted": "Joe Bloggs",
        "familyName": "Bloggs",
        "givenName": "Joe"
    },
    "e-mails" : [
        {
            "type": "work",
            "value": "Joe.bloggs2@workvivo.com",
            "primary": true
        }
    ],
    "Numéros de téléphone" : [
        {
            "primary": true,
            "type": "work",
            "value": "3534353"
        },
        {
            "primary": true,
            "type": "mobile",
            "value": "+354769999"
        }
    ],
    "adresses" : [
        {
            "locality": "Location Name", // Secondary Team
            "type": "work"
        }
    ],
    "titre" : "Intitulé du poste",
    "actif" : true,
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "service" : "Service", // Équipe principale
        "Centre de coûts" : "Opérations", // Équipe tertiaire
        "responsable" : {
            "displayName": "",
            "value": "654321", // Workvivo ID
            "$ref": ""
        },
        "taxonomies" : [  // Équipes supplémentaires
            {
                "displayName": "Dv1",
                "type": "Division"
            },
            {
                "displayName": "Workvivo",
                "type": "Company"
            }
        ]
    }
}

Exemple de demande SCIM PATCH :

URL de demande : https://[domaine client]/scim/v2/scim/Utilisateurs/662096
Exemple : https://company.workvivo.com/scim/v2/scim/Users/662096

Méthode de demande : Patch (mise à jour)

 

Demande d'échantillon :

{
    "schémas"–: [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Opérations" : [
        {
            "op": "add",
            "path": "title",
            "value": "New Job Title"
        }
    ]
}

Attributs par défaut et mappages vers Workvivo :
 

Voir ci-dessous pour les mappages de termes spécifiques. N'hésite pas à contacter ton interlocuteur Workvivo, par exemple pour les demandes d'appel ci-dessous, si nécessaire

• ExternalID : identifiant unique fourni par utilisateur qui permettra d'ancrer les informations utilisateur. Cela dictera toute modification du profil utilisateur
• Nom d'utilisateur et e-mail: champ e-mail dans Workvivo
• Prénom: Prénom/Prénom
• Nom : Nom/Prénom
• DisplayName : Nom d'affichage
• Actif: si le compte de l'utilisateur doit être actif ou désactivé
• Titre du poste : Intitulé du poste de l'utilisateur
• DirectDial: numéro de téléphone direct (professionnel)
• Téléphone portable : numéro de téléphone portable
• Date de naissance: Date de naissance
• HireDate : Date d'embauche
• Manager : responsable de l'utilisateur qui génère un organigramme
  • Remarque : cela doit être au format e-mail ou WorkvivoID. Dans le cas d'un e-mail, le fournisseur SCIM doit être Okta dans la capture d'écran au début
     

Autres types d'équipes :

Contacte ton contact Workvivo pour ajouter ou modifier des types d'équipes dans Workvivo

• Département: type d'équipe par défaut, lié au paramètre de structure principal
• Localité: type d'équipe par défaut, lié au réglage de la structure secondaire
• CostCenter : Configuration de la structure tertiaire

Pour en savoir plus sur nos types d’équipes et nos configurations de structure, consulte cet article du centre d’aide
 

Regarde le clip ci-dessous pour une démonstration vidéo :