Create pendingExternalUserProfile

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 .

Créez un objet pendingExternalUserProfile .

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

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit 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 utilisateur de l’annuaire étendu
  • Administrateur du service Teams

Requête HTTP

POST /directory/pendingExternalUserProfiles

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON d’un pendingExternalUserProfile.

Propriété Type Description
address physicalOfficeAddress Adresse du bureau du profil utilisateur externe en attente.
createdBy String ID d’objet de l’utilisateur qui a créé le profil utilisateur externe en attente. En lecture seule. Ne pouvant accepter la valeur null.
createdDateTime DateTimeOffset Date et heure de création de ce profil utilisateur externe en attente. Ne pouvant accepter la valeur null. En lecture seule.
CompanyName String Nom de la société du profil utilisateur externe en attente.
deletedDateTime DateTimeOffset Date et heure auxquelles le profil utilisateur externe en attente a été supprimé. Toujours null lorsque l’objet n’est pas supprimé.
Service String Service du profil utilisateur externe en attente.
displayName String Nom d’affichage du profil utilisateur externe en attente. Obligatoire.
époque Int Numéro de version du profil utilisateur externe en attente. Incrémenté à chaque mise à jour de l’entité. En lecture seule. Ne pouvant accepter la valeur null.
id String Identifiant unique pour le profil utilisateur externe en attente. Par exemple, 12345678-9abc-def0-1234-56789abcde. La valeur de la propriété id se présente souvent, mais pas exclusivement, sous la forme d’un GUID ; traitez-le comme un identificateur opaque et ne vous fiez pas à ce qu’il s’agisse d’un GUID. Clé. Ne peut pas avoir la valeur Null. En lecture seule.
est détectable Booléen Indique si le profil utilisateur externe en attente est détectable dans l’annuaire.
isEnabled Boolean Indique si le profil utilisateur externe en attente est activé dans l’annuaire.
jobTitle String Titre du poste du profil utilisateur externe.
phoneNumber String Numéro de téléphone du profil utilisateur externe en attente. Doit être au format E164. Obligatoire.
supervisorId String ID d’objet du superviseur du profil utilisateur externe en attente.

Réponse

En cas de réussite, cette méthode renvoie un 201 Created code de réponse et un objet pendingExternalUserProfile . En cas d’échec, une 4xx erreur est renvoyée avec des détails spécifiques.

Exemple

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/directory/pendingExternalUserProfiles
Content-type: application/json

{
    "phoneNumber": "+15555555555",
    "displayName": "Bob Henry"
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 201 Created
Content-type: application/json

{
    "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": null,
        "countryOrRegion": null,
        "officeLocation": null,
        "postalCode": null,
        "state": null,
        "street": null
    },
    "epoch":1,
    "createdBy":"67670e18-bf37-416c-b5c8-3bfdaad757cc",
    "supervisorId":null,
    "companyName":null
}