Update synchronizationSchema

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans 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 Version .

Mettez à jour le schéma de synchronisation pour un travail ou un modèle donné. Cette méthode remplace entièrement le schéma actuel par celui fourni dans la demande. Pour mettre à jour le schéma d’un modèle, effectuez l’appel sur l’objet application. Vous devez être le propriétaire de l’application.

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) Synchronization.ReadWrite.All CustomSecAttributeProvisioning.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Application.ReadWrite.OwnedBy CustomSecAttributeProvisioning.ReadWrite.All, Synchronization.ReadWrite.All

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit être propriétaire ou membre du groupe ou disposer d’un rôle Microsoft Entra pris en charge ou d’un rôle personnalisé qui accorde les autorisations requises pour cette opération. Cette opération prend en charge les rôles intégrés suivants, qui n’offrent que le moindre privilège nécessaire :

  • Administrateur de l'application
  • Administrateur de l'application cloud
  • Administrateur d’identité hybride - pour configurer la synchronisation cloud de Microsoft Entra

Requête HTTP

PUT /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
PUT /applications/{id}/synchronization/templates/{templateId}/schema

En-têtes de demande

Nom Type Description
Autorisation string Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.

Corps de la demande

Dans le corps de la demande, indiquez l’objet synchronizationSchema par lequel remplacer le schéma existant.

Réponse

En cas de réussite, renvoie un 204 No Content code de réponse. Elle ne renvoie rien dans le corps de la réponse.

Exemples

Exemple 1 : Mettre à jour le schéma

Demande

L’exemple suivant illustre une demande.

Remarque : L’objet de requête affiché ici est raccourci pour plus de lisibilité. Fournissez toutes les propriétés dans un appel réel.

PUT https://graph.microsoft.com/beta/servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
Content-type: application/json

{
    "directories": [
        {
            "name": "Azure Active Directory",
            "objects": [
                {
                    "name": "User",
                    "attributes": [
                        {
                            "name": "userPrincipalName",
                            "type": "string"
                        }
                    ]
                },
            ]
        },
        {
            "name": "Salesforce",
        }
    ],
    "synchronizationRules":[
        {
            "name": "USER_TO_USER",
            "sourceDirectoryName": "Azure Active Directory",
            "targetDirectoryName": "Salesforce",
            "objectMappings": [
                {
                    "sourceObjectName": "User",
                    "targetObjectName": "User",
                    "attributeMappings": [
                        {
                            "source": {},
                            "targetAttributeName": "userName"
                        }
                    ]
                }
            ]
        }
    ]
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Exemple 2 : ajouter l’attribut « CustomAttribute » au schéma système cible

Demande

L’exemple suivant illustre une demande. Elle suppose que l’attribut « CustomAttribute » n’existe pas dans le schéma d’annuaire cible. S’il existe, l’attribut est mis à jour.

Remarque : L’objet de requête affiché ici est raccourci pour plus de lisibilité. Fournissez toutes les propriétés dans un appel réel.

PUT https://graph.microsoft.com/beta/servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
Content-type: application/json

{
   "directories":[
      {
         "id":"09760868-cafb-47ac-9031-0a3262300427",
         "name":"customappsso",
         "objects":[
            {
               "name":"User",
               "attributes":[
                  {
                     "anchor":false,
                     "caseExact":false,
                     "defaultValue":null,
                     "flowNullValues":false,
                     "multivalued":false,
                     "mutability":"ReadWrite",
                     "name":"urn:ietf:params:scim:schemas:extension:CustomExtensionName:2.0:User:CustomAttribute",
                     "required":false,
                     "type":"String",
                     "apiExpressions":[],
                     "metadata":[],
                     "referencedObjects":[]
                  }
               ]
            }
         ]
      }
   ]
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Exemple 3 : Ajouter un nouveau mappage d’attributs aux règles de synchronisation

Demande

L’exemple suivant illustre une demande. Le synchornizationSchema a une relation un-à-plusieurs entre targetAttributeName et les attributs source . Si votre schéma n’a pas « timezone » comme attribut cible, le service ajoute un nouveau mappage pour extensionAttribute11 --> timezone. Si votre application a un fuseau horaire comme attribut cible dans le schéma, le service génère une erreur, car un attribut ne peut être mappé en tant que cible qu’une seule fois. De plus, l’attribut doit exister dans le schéma avant de pouvoir être ajouté aux mappages.

Remarque : L’objet de requête affiché ici est raccourci pour plus de lisibilité. Fournissez toutes les propriétés dans un appel réel.

PUT https://graph.microsoft.com/beta/servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
Content-type: application/json

{
   "@odata.type":"#microsoft.graph.synchronizationSchema",
   "synchronizationRules":[
      {
         "defaultValue":"",
         "exportMissingReferences":false,
         "flowBehavior":"FlowWhenChanged",
         "flowType":"Always",
         "matchingPriority":0,
         "source":{
            "expression":"[extensionAttribute11]",
            "name":"extensionAttribute11",
            "parameters":[],
            "type":"Attribute"
         },
         "targetAttributeName":"timezone"
      }
   ]
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content
  • Last updated on