Créer extensionProperty (extension de répertoire)

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 une nouvelle définition d’extension d’annuaire, représentée par un objet extensionProperty .

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) Application.ReadWrite.All Directory.ReadWrite.All
Déléguée (compte Microsoft personnel) Application.ReadWrite.All Non disponible.
Application Application.ReadWrite.OwnedBy Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All

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 :

  • Rédacteurs d'annuaires
  • Administrateur de l'application cloud
  • Administrateur de l'application

Requête HTTP

POST /applications/{application ObjectId}/extensionProperties
POST /applications(appId='{appId}')/extensionProperties

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 à un objet extensionProperty les propriétés suivantes.

Propriété Type Description
dataType String Spécifie le type de données de la valeur que la propriété d’extension peut contenir. Les valeurs suivantes sont prises en charge.
  • Binary - 256 octets maximum
  • Boolean
  • DateTime - Doit être spécifié au format ISO 8601. Conservées au format UTC.
  • Integer - Valeur 32 bits.
  • LargeInteger - Valeur 64 bits.
  • String - 256 caractères maximum
Ne pouvant accepter la valeur null. Pour les extensions d’annuaire à plusieurs valeurs, ces limites s’appliquent par valeur dans la collection.
nom String Nom de la propriété d’extension. Ne pouvant accepter la valeur null.
isMultiValued Booléen Définit l’extension d’annuaire en tant que propriété à valeurs multiples. Lorsque true, la propriété d’extension d’annuaire peut stocker une collection d’objets du DataType, par exemple une collection de types de chaîne tels que "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_jobGroupTracker": ["String 1", "String 2"]. La valeur par défaut est false.
targetObjects String collection Ressources Microsoft Graph qui peuvent utiliser la propriété extension. Toutes les valeurs doivent être en PascalCase. Les valeurs suivantes sont prises en charge. Ne pouvant accepter la valeur null.
  • User
  • Group
  • AdministrativeUnit
  • Application
  • Device
  • Organization

Réponse

En cas de réussite, cette méthode renvoie 201, Created un code de réponse et un nouvel objet extensionProperty dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/applications/fd918e4b-c821-4efb-b50a-5eddd23afc6f/extensionProperties
Content-type: application/json

{
    "name": "jobGroup",
    "dataType": "String",
    "isMultiValued": true,
    "targetObjects": [
        "User"
    ]
}

Réponse

En cas de réussite, cette méthode renvoie un code de réponse et un 201 Created objet extensionProperty dans le corps de la réponse.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#applications('fd918e4b-c821-4efb-b50a-5eddd23afc6f')/extensionProperties/$entity",
    "id": "da38c7b1-133e-4a79-abcd-e2fd586ce621",
    "deletedDateTime": null,
    "appDisplayName": "b2c-extensions-app. Do not modify. Used by AADB2C for storing user data.",
    "dataType": "String",
    "isMultiValued": true, 
    "isSyncedFromOnPremises": false,
    "name": "extension_25883231668a43a780b25685c3f874bc_jobGroup",
    "targetObjects": [
        "User"
    ]
}