Partager via


Créer extensionProperty (extension de répertoire)

Espace de noms: microsoft.graph

Créez une définition d’extension de répertoire, représentée par un objet extensionProperty .

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

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

Corps de la demande

Dans le corps de la demande, fournissez un objet extensionProperty avec 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 de répertoire à plusieurs valeurs, ces limites s’appliquent par valeur dans la collection.
nom Chaîne Nom de la propriété d’extension. Ne pouvant accepter la valeur null.
isMultiValued Valeur booléenne Définit l’extension de répertoire en tant que propriété à valeurs multiples. Quand truela valeur est , la propriété d’extension d’annuaire peut stocker une collection d’objets du dataType ; par exemple, une collection de types de chaînes telles que "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_jobGroupTracker": ["String 1", "String 2"]. La valeur par défaut est false.
targetObjects String collection Ressources Microsoft Graph pouvant utiliser la propriété d’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

Si elle réussit, cette méthode renvoie un 201 Created 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/v1.0/applications/fd918e4b-c821-4efb-b50a-5eddd23afc6f/extensionProperties
Content-type: application/json

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

Réponse

Si elle réussit, cette méthode renvoie 201 Created le code de réponse et l’objet extensionProperty dans le corps de la réponse.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$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"
    ]
}