driveItem: assignSensitivityLabel

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.

Asigne de forma asincrónica una etiqueta de confidencialidad a un driveItem.

Esta API forma parte de las API de Microsoft SharePoint y OneDrive que realizan funciones administrativas premium avanzadas y se considera una API protegida. Las API protegidas requieren que tenga más validación, más allá del permiso y el consentimiento, para poder usarlas.

Nota:

Se trata de una API de uso medido y se pueden aplicar algunos cargos por uso. Para obtener más información, consulte Introducción a las API de Microsoft 365 medidas en Microsoft Graph. Antes de llamar a esta API, debe habilitar las API y los servicios medidos en Microsoft Graph.

Esta API aplica etiquetas de confidencialidad a los archivos en reposo. Los clientes de Office no aplican marcas de agua, encabezados o pies de página a los archivos que contienen la información de la etiqueta. Para obtener más información sobre las etiquetas de confidencialidad desde la perspectiva de un administrador, vea Habilitar etiquetas de confidencialidad para archivos de Office en SharePoint y OneDrive.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	❌	❌	❌

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores 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)	Files.ReadWrite.All	Sites.ReadWrite.All
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	Files.ReadWrite.All	Sites.ReadWrite.All

Solicitud HTTP

POST /drives/{drive-id}/items/{item-id}/assignSensitivityLabel
POST /drives/{drive-id}/root:/{item-path}:/assignSensitivityLabel
POST /groups/{group-id}/drive/items/{item-id}/assignSensitivityLabel
POST /groups/{group-id}/drive/root:/{item-path}:/assignSensitivityLabel
POST /me/drive/items/{item-id}/assignSensitivityLabel
POST /me/drive/root:/{item-path}:/assignSensitivityLabel
POST /sites/{site-id}/drive/items/{item-id}/assignSensitivityLabel
POST /sites/{site-id}/drive/root:/{item-path}:/assignSensitivityLabel
POST /users/{user-id}/drive/items/{item-id}/assignSensitivityLabel
POST /users/{user-id}/drive/root:/{item-path}:/assignSensitivityLabel

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione el identificador de la etiqueta de confidencialidad que se va a asignar a un archivo determinado. En la tabla siguiente se enumeran los parámetros de entrada obligatorios y opcionales.

Nombre	Valor	Descripción
sensitivityLabelId	Cadena	Obligatorio. Identificador de la etiqueta de confidencialidad que se va a asignar o cadena vacía para quitar la etiqueta de confidencialidad.
assignmentMethod	sensitivityLabelAssignmentMethod	Opcional. Método de asignación de la etiqueta en el documento. Indica si la asignación de la etiqueta se realizó automáticamente, estándar o como una operación con privilegios (equivalente a una operación de administrador).
justificationText	Cadena	Opcional. Texto de justificación con fines de auditoría. Necesario al degradar o quitar una etiqueta.

Respuesta

Si se ejecuta correctamente, la API devuelve un 202 Accepted código de respuesta HTTP con un cuerpo de respuesta vacío. El Location encabezado proporciona la dirección URL para obtener los detalles de la operación. Para obtener más información sobre cómo supervisar el progreso de una operación de asignación de etiquetas de confidencialidad, consulte Supervisión de operaciones de larga duración.

Además de los errores generales que se aplican a Microsoft Graph, esta API devuelve el 423 Locked código de respuesta, lo que indica que el archivo al que se accede está bloqueado. En tales casos , la propiedad code del objeto de respuesta indica el tipo de error que bloquea la operación. Además, la aplicación no puede actualizar algunas etiquetas de confidencialidad protegidas por Irm y necesita acceso de usuario delegado para validar si el usuario tiene los derechos adecuados. En estos escenarios, la API produce código de Not Supported respuesta.

En la tabla siguiente se enumeran los valores posibles para los tipos de error.

Valor	Descripción
fileDoubleKeyEncrypted	Indica que el archivo está protegido mediante el cifrado de doble clave; por lo tanto, no se puede abrir.
fileDecryptionNotSupported	Indica que el archivo cifrado tiene propiedades específicas que no permiten que SharePoint abra estos archivos.
fileDecryptionDeferred	Indica que el archivo se está procesando para el descifrado; por lo tanto, no se puede abrir.
unknownFutureValue	Valor de sentinel de enumeración evolvable. No usar.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

HTTP

POST https://graph.microsoft.com/beta/drive/root/items/016GVDAP3RCQS5VBQHORFIVU2ZMOSBL25U/assignSensitivityLabel
Content-Type: application/json

{
  "sensitivityLabelId": "5feba255-812e-446a-ac59-a7044ef827b5",
  "assignmentMethod": "standard",
  "justificationText": "test_justification"
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const assignSensitivityLabel = {
  sensitivityLabelId: '5feba255-812e-446a-ac59-a7044ef827b5',
  assignmentMethod: 'standard',
  justificationText: 'test_justification'
};

await client.api('/drive/root/items/016GVDAP3RCQS5VBQHORFIVU2ZMOSBL25U/assignSensitivityLabel')
	.version('beta')
	.post(assignSensitivityLabel);

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 202 Accepted
Location: https://contoso.sharepoint.com/_api/v2.0/monitor/QXNzaWduU2Vuc2l0aXZpdHlMYWJlbCxiMzc3ODY3OS04OWQ3LTRkYmYtYjg0MC1jYWM1NzRhY2FlNmE?tempAuth=eyJ0eXAiOiJKV1QiLCJhb....

El valor del Location encabezado proporciona una dirección URL para un servicio que devolverá el estado actual de la operación asignar etiqueta de confidencialidad. Puede usar esta información para determinar cuándo ha finalizado la operación de asignación de etiquetas de confidencialidad.

Comentarios

La respuesta de la API solo indica que se ha aceptado o rechazado la operación de asignación de etiqueta de confidencialidad. La operación podría rechazarse, por ejemplo, si no se admite el tipo de archivo o si el archivo está cifrado doble.