Create pendingExternalUserProfile

Article
10/11/2024

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 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)	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

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 :

Administrateur d’utilisateurs d’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 l’autorisation.
Content-Type	application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON d’un objet 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 de suppression du profil utilisateur externe en attente. Toujours `null` quand l’objet n’est pas supprimé.
Service	String	Service du profil utilisateur externe en attente.
displayName	String	Nom complet 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	Identificateur unique du profil utilisateur externe en attente. Par exemple, 12345678-9abc-def0-1234-56789abcde. La valeur de la propriété id est souvent, mais pas exclusivement, sous la forme d’un GUID ; traitez-la comme un identificateur opaque et ne vous y fiez pas en tant que GUID. Clé. Ne peut pas avoir la valeur Null. En lecture seule.
isDiscoverable	Boolean	Indique si le profil utilisateur externe en attente est détectable dans le répertoire.
isEnabled	Boolean	Indique si le profil utilisateur externe en attente est activé dans le répertoire.
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

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet pendingExternalUserProfile . En cas d’échec, une 4xx erreur est retourné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"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new PendingExternalUserProfile
{
	PhoneNumber = "+15555555555",
	DisplayName = "Bob Henry",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.PendingExternalUserProfiles.PostAsync(requestBody);

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).



mgc-beta directory pending-external-user-profiles create --body '{\
    "phoneNumber": "+15555555555",\
    "displayName": "Bob Henry"\
}\
'

Importante



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewPendingExternalUserProfile()
phoneNumber := "+15555555555"
requestBody.SetPhoneNumber(&phoneNumber) 
displayName := "Bob Henry"
requestBody.SetDisplayName(&displayName) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
pendingExternalUserProfiles, err := graphClient.Directory().PendingExternalUserProfiles().Post(context.Background(), requestBody, nil)

Importante


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

PendingExternalUserProfile pendingExternalUserProfile = new PendingExternalUserProfile();
pendingExternalUserProfile.setPhoneNumber("+15555555555");
pendingExternalUserProfile.setDisplayName("Bob Henry");
PendingExternalUserProfile result = graphClient.directory().pendingExternalUserProfiles().post(pendingExternalUserProfile);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const pendingExternalUserProfile = {
    phoneNumber: '+15555555555',
    displayName: 'Bob Henry'
};

await client.api('/directory/pendingExternalUserProfiles')
	.version('beta')
	.post(pendingExternalUserProfile);

Importante


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\PendingExternalUserProfile;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new PendingExternalUserProfile();
$requestBody->setPhoneNumber('+15555555555');
$requestBody->setDisplayName('Bob Henry');

$result = $graphServiceClient->directory()->pendingExternalUserProfiles()->post($requestBody)->wait();

Importante


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	phoneNumber = "+15555555555"
	displayName = "Bob Henry"
}

New-MgBetaDirectoryPendingExternalUserProfile -BodyParameter $params

Importante


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.pending_external_user_profile import PendingExternalUserProfile
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = PendingExternalUserProfile(
	phone_number = "+15555555555",
	display_name = "Bob Henry",
)

result = await graph_client.directory.pending_external_user_profiles.post(request_body)

Importante

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
}

Partager via

Create pendingExternalUserProfile

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemple

Demande

Réponse

Commentaires

Ressources supplémentaires