Create extensionProperty (directory extension)

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Cree una nueva definición de extensión de directorio, representada por un objeto extensionProperty .

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet
✅ ✅ ✅ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) Application.ReadWrite.All Directory.ReadWrite.All
Delegado (cuenta personal de Microsoft) Application.ReadWrite.All No disponible.
Aplicación Application.ReadWrite.OwnedBy Application.ReadWrite.All, Directory.ReadWrite.All

Importante

Para el acceso delegado con cuentas profesionales o educativas, el usuario que ha iniciado sesión debe tener asignado un rol compatible de Microsoft Entra o un rol personalizado que conceda los permisos necesarios para esta operación. Esta operación admite los siguientes roles integrados, que proporcionan solo el privilegio mínimo necesario:

  • Escritores de directorios
  • Administrador de aplicaciones en la nube
  • Administrador de la aplicación

Solicitud HTTP

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

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione un objeto extensionProperty con las siguientes propiedades.

Propiedad Tipo Descripción
dataType Cadena Especifica el tipo de datos del valor que puede contener la propiedad de extensión. Se admiten los valores siguientes.
  • Binary - 256 bytes máximo
  • Boolean
  • DateTime - Debe especificarse en formato ISO 8601. Se almacenarán en UTC.
  • Integer - Valor de 32 bits.
  • LargeInteger - Valor de 64 bits.
  • String - 256 caracteres como máximo
No admite valores NULL. Para las extensiones de directorio multivalor, estos límites se aplican por valor de la colección.
name Cadena Nombre de la propiedad de extensión. No admite valores NULL.
isMultiValued Booleano Define la extensión del directorio como una propiedad de varios valores. Cuando true, la propiedad de extensión de directorio puede almacenar una colección de objetos de dataType; por ejemplo, una colección de tipos de cadena como "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_jobGroupTracker": ["String 1", "String 2"]. El valor predeterminado es false.
objetos de destino Colección string Los recursos de Microsoft Graph que pueden usar la propiedad de extensión. Todos los valores deben estar en PascalCase. Se admiten los siguientes valores. No admite valores NULL.
  • User
  • Group
  • AdministrativeUnit
  • Application
  • Device
  • Organization

Respuesta

Si tiene éxito, este método devuelve 201, Created código de respuesta y un nuevo objeto extensionProperty en el cuerpo de la respuesta.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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"
    ]
}

Respuesta

Si tiene éxito, este método devuelve un 201 Created código de respuesta y un objeto extensionProperty en el cuerpo de la respuesta.

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"
    ]
}