Partager via

Répertorier externalUserProfiles

  • Article

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 .

Récupérer les propriétés de tous les externalUserProfiles

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

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

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

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) ExternalUserProfile.Read.All ExternalUserProfile.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application ExternalUserProfile.Read.All ExternalUserProfile.ReadWrite.All

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. Les rôles les moins privilégiés suivants sont pris en charge pour cette opération :

  • Lecteur général
  • Administrateur d’utilisateurs d’annuaire étendu
  • Administrateur du service Teams

Requête HTTP

GET /directory/externalUserProfiles/{id}

Paramètres facultatifs de la requête

Vous pouvez utiliser $filter pour retourner uniquement des profils utilisateur externes spécifiques. Les propriétés suivantes peuvent être utilisées pour $filter:

  • CompanyName
  • supervisorId

Pour plus d’informations, 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 l’autorisation.

Corps de la demande

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

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et une représentation JSON de externalUserProfile dans le corps de la réponse.

Exemples

Exemple 1 : Obtenir tous les profils utilisateur externes

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/directory/externalUserProfiles

Réponse

L’exemple suivant illustre la réponse.

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

{
    "value": [
        {
            "id":"1e4ba82a-5f0c-423c-83e1-fc8ad69d8f02",
            "isEnabled":true,
            "createdDateTime":"2020-11-12T17:53:48Z",
            "deletedDateTime":null,
            "department":null,
            "displayName":"Bob Henry",
            "isDiscoverable":true,
            "jobTitle":null,
            "phoneNumber":"4257034568",
            "address":{
                  "city":"Redmond",
                  "countryOrRegion":"USA",
                  "officeLocation":"B28",
                  "postalCode":"98052",
                  "state":"WA",
                  "street":"One Microsoft Way"
                  },
            "createdBy":"67670e18-bf37-416c-b5c8-3bfdaad757cc",
            "supervisorId":null,
            "companyName":null
        },
        {
            "id":"fffba82a-fffc-ff3c-83e1-fc8ff9dfff",
            "isEnabled":true,
            "createdDateTime":"2020-11-12T17:53:48Z",
            "deletedDateTime":null,
            "department":null,
            "displayName":"Jack Hill",
            "isDiscoverable":false,
            "jobTitle":null,
            "phoneNumber":"4257034788",
            "address":{
                  "city":"Redmond",
                  "countryOrRegion":"USA",
                  "officeLocation":"B28",
                  "postalCode":"98052",
                  "state":"WA",
                  "street":"One Microsoft Way"
                  },
            "createdBy":"67670e18-bf37-416c-b5c8-3bfdaad757cc",
            "supervisorId":null,
            "companyName":null
        }
    ]
}

Exemple 2 : Répertorier tous les profils utilisateur externes détectables

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/directory/externalUserProfiles$filter=isDiscoverable eq true

Réponse

L’exemple suivant illustre la réponse.

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

{
    "value": [
        {
            "id":"1e4ba82a-5f0c-423c-83e1-fc8ad69d8f02",
            "isEnabled":true,
            "createdDateTime":"2020-11-12T17:53:48Z",
            "deletedDateTime":null,
            "department":null,
            "displayName":"Bob Henry",
            "isDiscoverable":true,
            "jobTitle":null,
            "phoneNumber":"4257034568",
            "address":{
                  "city":"Redmond",
                  "countryOrRegion":"USA",
                  "officeLocation":"B28",
                  "postalCode":"98052",
                  "state":"WA",
                  "street":"One Microsoft Way"
                  },
            "createdBy":"67670e18-bf37-416c-b5c8-3bfdaad757cc",
            "supervisorId":null,
            "companyName":null
        }
    ]
}