Obtenir objectConnection

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 .

Obtenir l’enregistrement de liaison mise en cache objectConnection pour un objet connu dans une tâche de synchronisation.

Lors de la préversion publique, vous devez spécifier un objectId connu. La liste des collections n’est pas prise en charge ; une requête GET à la collection objectConnections renvoie 400 Bad Request.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ❌ ❌ ❌

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) SynchronizationMetadata.Read.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application SynchronizationMetadata.Read.OwnedBy SynchronizationMetadata.Read.All

L’autorisation SynchronizationMetadata.ReadWrite.All prend également en charge cette opération pour les comptes et applications professionnels ou scolaires délégués. L’autorisation SynchronizationMetadata.ReadWrite.OwnedBy d’application prend également en charge cette opération.

Les SynchronizationMetadata.Read.OwnedBy autorisations d’application et SynchronizationMetadata.ReadWrite.OwnedBy restreignent l’accès aux tâches de synchronisation associées aux principaux de service appartenant à l’application appelante.

Requête HTTP

GET /servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/objectConnections/{objectId}

Remplacez-le {objectId} par l’identificateur exact de source ou de cible de l’objet dans cette tâche de synchronisation. Par exemple, utilisez l’ID d’objet Microsoft Entra pour le côté Microsoft Entra d’une connexion ou le WID du travailleur Workday pour la source Workday. Le service recherche d’abord un identificateur de source, puis un identificateur de cible. Conservez le format d’origine de l’identifiant.

Paramètres facultatifs de la requête

Cette méthode prend uniquement en charge le paramètre de $select requête OData pour personnaliser la réponse. Les autres paramètres de requête OData ne sont pas pris en charge. Pour des informations générales, consultez paramètres de la requête OData.

En-têtes de demande

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

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

En cas de réussite, cette méthode renvoie un code de réponse et un 200 OK objet objectConnection dans le corps de la réponse.

Erreurs

HTTP status Condition
401 Unauthorized L’appelant n’est pas authentifié, ne dispose pas de la portée déléguée ou échoue aux vérifications d’autorisation déléguée.
403 Forbidden L’autorisation d’application requise est manquante ou l’appelant ne peut pas accéder à la tâche de synchronisation demandée.
404 Not Found La tâche de synchronisation ou la connexion d’objet n’existe pas.
429 Too Many Requests La demande est ralentie.

Exemples

Demande

L’exemple suivant utilise l’ID d’objet Microsoft Entra de l’utilisateur source en tant que {objectId}.

GET https://graph.microsoft.com/beta/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/objectConnections/9d47c4a5-0d5a-4c0e-91b6-6f6c9c6e4c77

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "objectId": "9d47c4a5-0d5a-4c0e-91b6-6f6c9c6e4c77",
  "sourceAnchor": "9d47c4a5-0d5a-4c0e-91b6-6f6c9c6e4c77",
  "targetAnchor": "EXTERNAL_userA",
  "displayName": "User A",
  "objectTypeName": "User"
}

Contenu connexe

  • Dernière mise à jour :