Vue d’ensemble de l’API de synchronisation Azure AD

Espace de noms: microsoft.graph

Important

Les API sous la /beta version de Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur de version .

La synchronisation d’identités Azure Active Directory (Azure AD) (également appelée « approvisionnement ») vous permet d’automatiser l’approvisionnement (création, maintenance) et la désapprovisionnement (suppression) des identités à partir de l’une des opérations suivantes :

  • Active Directory vers Azure AD
  • Workday vers Azure AD
  • Azure AD vers les applications cloud telles que Dropbox, Salesforce, ServiceNow, et bien plus encore

Vous pouvez utiliser les API de synchronisation dans Microsoft Graph pour la gestion de la synchronisation d’identité par programme, notamment :

  • Créer, démarrer et stopper des tâches de synchronisation
  • Apporter des modifications au schéma de synchronisation des tâches
  • Vérifier l’état actuel de la synchronisation

Pour plus d’informations sur la synchronisation dans Azure AD, voir :

Vous pouvez également essayer l’API dans l’Afficheur Graph dans un exemple de client ou dans votre propre client.

Travail de synchronisation

Les travaux de synchronisation effectuent la synchronisation en s’exécutant régulièrement en arrière-plan, en sondant les modifications dans un répertoire et en les pushant vers un autre répertoire. Le travail de synchronisation est toujours spécifique à une instance spécifique d’une application dans votre client. Dans le cadre de la configuration du travail de synchronisation, vous devez accorder l’autorisation de lire et d’écrire des objets dans votre répertoire cible et personnaliser le schéma de synchronisation du travail.

Pour plus d’informations, voir travail de synchronisation.

Schéma de synchronisation

Le schéma de synchronisation définit les objets qui seront synchronisés et la façon dont ils seront synchronisés. Le schéma de synchronisation contient la plupart des informations d’installation d’un travail de synchronisation particulier. En règle générale, vous personnalisez certains mappagesd’attributs ou ajoutez un filtre d’échelle pour synchroniser uniquement les objets qui répondent à une certaine condition.

Le schéma de synchronisation inclut les composants suivants :

  • Définitions d’annuaire
  • Règles de synchronisation
  • Mappages d’objets

Pour plus d’informations, voir schéma de synchronisation.

Modèle de synchronisation

Le modèle de synchronisation fournit des paramètres de synchronisation pré-configurés pour une application particulière. Ces paramètres (plus important encore,le schéma de synchronisation) seront utilisés par défaut pour tout travail de synchronisation basé sur le modèle. Les modèles sont spécifiés par le développeur d’applications.

Pour plus d’informations, voir le modèle de synchronisation.

Travailler avec l’API de synchronisation

L’api de synchronisation implique principalement d’accéder aux ressources synchronizationJob et synchronizationSchema. Pour trouver votre ressource synchronizationJob, vous devez connaître l’ID de l’objet principal de service à qui appartient le travail de synchronisation. Les exemples suivants vous montrent comment travailler avec les ressources synchronizationJob et synchronizationSchema.

Authorization

L’API de synchronisation Azure AD utilise OAuth 2.0 pour l’autorisation. Avant d’effectuer des demandes à l’API, vous devez obtenir un jeton d’accès. Pour plus d’informations, voir Obtenir des jetons d’accès pour appeler Microsoft Graph. Pour accéder aux ressources de synchronisation, votre application a besoin d’autorisations Directory.ReadWrite.All. Pour plus d’informations, voir autorisations d’annuaire.

Rechercher l’objet principal de service par nom d’affichage

L’exemple suivant montre comment rechercher un objet principal de service par nom d’affichage.

Demande

GET https://graph.microsoft.com/beta/servicePrincipals?$select=id,appId,displayName&$filter=startswith(displayName, 'salesforce')

Réponse

HTTP/1.1 200 OK

{
   "value":[
      {
         "id":"bc0dc311-87df-48ac-91b1-259bd2c3a31c",
         "appId":"f7808c5e-cb57-4e37-8094-406d302c0f8d",
         "displayName":"Salesforce"
      },
      {
         "id":"d813d7d7-0f41-4edc-b284-d0dfaf399d15",
         "appId":"219561ee-1480-4c67-9aa6-63d861fae3ef",
         "displayName":"salesforce 3"
      }
   ]
}

Rechercher l’objet principal de service par ID d’application

L’exemple suivant montre comment trouver l’objet principal de service par ID d’application.

Demande

GET https://graph.microsoft.com/beta/servicePrincipals?$select=id,appId,displayName&$filter=AppId eq '219561ee-1480-4c67-9aa6-63d861fae3ef'

Réponse

HTTP/1.1 200 OK

{
    "value": [
        {
            "id": "d813d7d7-0f41-4edc-b284-d0dfaf399d15",
            "appId": "219561ee-1480-4c67-9aa6-63d861fae3ef",
            "displayName": "salesforce 3"
        }
    ]
}

Liste des travaux de synchronisation existants

L’exemple suivant montre comment lister les travaux de synchronisation existants.

Demande

GET https://graph.microsoft.com/beta/servicePrincipals/{id}/synchronization/jobs
GET https://graph.microsoft.com/beta/servicePrincipals/60443998-8cf7-4e61-b05c-a53b658cb5e1/synchronization/jobs

Réponse

HTTP/1.1 200 OK

{
    "value": [
        {
            "id": "SfSandboxOutDelta.e4bbf44533ea4eabb17027f3a92e92aa",
            "templateId": "SfSandboxOutDelta",
            "schedule": {
                "expiration": null,
                "interval": "PT20M",
                "state": "Active"
            },
            "status": {}
        }
    ]
}

Obtenir l’état du travail de synchronisation

L’exemple suivant montre comment obtenir l’état d’un travail de synchronisation.

Demande

GET https://graph.microsoft.com/beta/servicePrincipals/{id}/synchronization/jobs/{jobId}

GET https://graph.microsoft.com/beta/servicePrincipals/60443998-8cf7-4e61-b05c-a53b658cb5e1/synchronization/jobs/SfSandboxOutDelta.e4bbf44533ea4eabb17027f3a92e92aa

Réponse

HTTP/1.1 200 OK

{
    "id": "SfSandboxOutDelta.e4bbf44533ea4eabb17027f3a92e92aa",
    "templateId": "SfSandboxOutDelta",
    "schedule": {
        "expiration": null,
        "interval": "PT20M",
        "state": "Active"
    },
    "status": {}
}

Obtenir le schéma de synchronisation

L’exemple suivant montre comment obtenir le schéma de synchronisation.

Demande

GET https://graph.microsoft.com/beta/servicePrincipals/{id}/synchronization/jobs/{jobId}/schema

Réponse

HTTP/1.1 200 OK

{
    "directories": [],
    "synchronizationRules": []
}

Voir aussi