sensitivityLabel type de ressource

Espace de noms : microsoft.graph.security

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 .

Décrit l’étiquette de protection des informations qui détaille comment appliquer correctement une étiquette de confidentialité aux informations. La ressource informationProtectionLabel décrit la configuration des étiquettes de confidentialité qui s’appliquent à un utilisateur ou à un client.

Méthodes

Méthode Type de retour Description
List collection microsoft.graph.security.sensitivityLabel Obtenez une liste des objets microsoft.graph.security.sensitivityLabel et de leurs propriétés.
Obtenir microsoft.graph.security.sensitivityLabel Lisez les propriétés et les relations d’un objet microsoft.graph.security.sensitivityLabel .
Héritage de calcul microsoft.graph.security.sensitivityLabel Calculez l’héritage de l’étiquette de confidentialité et du contenu d’entrée.
Droits de calcul et héritage computeRightsAndInheritanceResult Calculez les droits et l’héritage de l’étiquette de confidentialité.
Évaluer l’application microsoft.graph.security.informationProtectionCollection Action Étant donné une entrée de contentInfo et labelingOptions, calculez l’ensemble des actions requises pour appliquer l’étiquette.
Évaluer le résultat de la classification microsoft.graph.security.informationProtectionCollection Action À partir d’une entrée de contentInfo et des résultats de classification, calculez l’ensemble des actions requises pour appliquer l’étiquette.
Évaluer la suppression microsoft.graph.security.informationProtectionCollection Action Étant donné une entrée de contentInfo et de downgradeJustification, calculez les actions qui doivent être effectuées pour supprimer l’étiquette.
Extraire l’étiquette de contenu microsoft.graph.security.contentLabel Étant donné une entrée de contentInfo, retournez les détails sur informationProtectionLabel que les métadonnées représentent.
Répertorier les étiquettes de confidentialité de sécurité et de conformité des données collection microsoft.graph.security.sensitivityLabel Obtenez une liste des objets sensitivityLabel et de leurs propriétés à l’aide de l’API de sécurité et de gouvernance des données.
Obtenir une étiquette de confidentialité de la sécurité et de la conformité des données collection microsoft.graph.security.sensitivityLabel Obtenez un objet sensitivityLabel et ses propriétés à l’aide de l’API de sécurité et de gouvernance des données.
Obtenir les droits d’utilisation inclus usageRightsIncluded collection Obtenir les droits d’utilisation accordés à l’utilisateur appelant.

Propriétés

Propriété Type Description
actionSource microsoft.graph.security.labelActionSource Indique la source de l’action qui a entraîné l’application de l’étiquette. Les valeurs possibles sont : manual, automatic, recommended, none.
Étiquetage automatique Étiquetage automatique Configuration de l’étiquetage automatique pour l’étiquette.
applicable à microsoft.graph.security.sensitivityLabelTarget Spécifie les charges de travail où l’étiquette peut être appliquée. Valeurs possibles : email, , site, unifiedGroup, teamworkfile, schematizedData, .
applicationMode microsoft.graph.security.applicationMode Spécifie la façon dont l’étiquette doit être appliquée ou recommandée. Les valeurs possibles sont manual, automatic, recommended.
assignedPolicies Collection labelPolicy L’ensemble des stratégies d’étiquette affectées à l’étiquette.
autoTooltip String Info-bulle affichée aux utilisateurs pour les étiquettes recommandées ou appliquées automatiquement.
color String Couleur que l’interface utilisateur doit afficher pour l’étiquette, si elle est configurée.
Formats de contenu String collection Renvoie les formats de contenu pris en charge pour l’étiquette.
description String Description de l’étiquette définie par l’administrateur.
displayName String Nom d’affichage de l’étiquette de confidentialité.
hasProtection Booléen Indique si l’étiquette comporte des actions de protection (telles que le chiffrement ou ne pas transférer) configurées.
id String L’ID d’étiquette est un identificateur global unique (GUID).
isActive Booléen Indique si l’étiquette est active ou non. Les étiquettes actives doivent être masquées ou désactivées dans l’interface utilisateur.
isAppliable Booléen Indique si l’étiquette peut être appliquée au contenu. False si l’étiquette est un parent avec des étiquettes enfants.
isDefault Booléen true si l’étiquette est l’étiquette par défaut de la stratégie ; false sinon.
isEnabled Boolean true si l’étiquette est actuellement activée ; false sinon.
isEndpointProtectionEnabled Booléen true si l’étiquette fournit des paramètres de protection appliqués par la protection contre la perte de données du point de terminaison ; false sinon.
isScopedToUser Booléen Indique si l’étiquette est limitée à des utilisateurs ou des groupes spécifiques (true) ou disponible à l’ensemble du client (false).
labelActions collection labelActionBase Actions associées à l’étiquette.
local String Paramètre régional associé aux propriétés localisées de l’étiquette (par exemple, « fr-FR »). Utilisé dans le contexte d’étiquettes de liste limitées à utilisateur/paramètres régionaux.
nom String Nom en texte brut de l’étiquette.
priorité Int32 Priorité de l’étiquette. Les nombres inférieurs indiquent une priorité plus élevée.
sensitivity Int32 Valeur de sensibilité de l’étiquette, où la valeur inférieure est la moins sensible.
tooltip String Info-bulle qui doit être affichée pour l’étiquette dans une interface utilisateur.

Règles de filtrage de l’API d’étiquette de confidentialité

Cette section décrit les règles et contraintes de filtrage disponibles à appliquer aux différents appels d’API d’étiquette de confidentialité.

Scénario 1 : renvoyer des étiquettes de confidentialité (1 ou plus)

L’utilisateur appelle l’API et filtre par un ou plusieurs GUID d’ID d’étiquette.

Exemple

$filter=((id eq 'guid1') or (id eq 'guid2') or (id eq 'guid3'))

Règles

  1. Restriction OU avec isScopedToUser

    • Si isScopedToUser le paramètre de filtre est présent, il or n’est pas autorisé dans les paramètres de filtre
  2. Comportement de préfiltrage avec OR

    • Si or est présent dans les paramètres de filtre, alors locale les paramètres de contentFormats filtre (s’ils sont présents) ne seront pas utilisés pour le préfiltrage
  3. Exception OR interne

    • Les opérations internes or relevant de l’arborescence de paramètres sont autorisées

Scénario 2 : retourner des résultats pour les étiquettes de confidentialité à l’aide d’un filtre sur un seul ID et un seul droit d’utilisateur

L’utilisateur appelle l’API et filtre en fonction d’une étiquette d’ID, d’un GUID et d’un droit utilisateur.

Exemple

$filter=(id eq 'guid1' and ownerEmail eq 'ownerEmail1')

Règles

  1. Restriction OR avec plusieurs paramètres

    • Si l’un des paramètres de filtre suivants est présent : isScopedToUser, idou ownerEmail, or n’est pas autorisé dans les paramètres de filtre
  2. propriétaireValidation e-mail

    • ownerEmail présent sans id jette un ArgumentException.
  3. Comportement de préfiltrage avec OR

    • Si or est présent dans la chaîne $filter, les locale paramètres de filtre sont contentFormats ignorés et ne sont pas utilisés pour préfiltrer les résultats.
  4. Exception OR interne

    • Vous pouvez utiliser des opérations internes or entre des clauses individuelles.

Scénario 2.5 : Retourner des résultats pour les étiquettes de confidentialité à l’aide d’un filtre pour les ID multiples et les droits d’utilisateur

L’utilisateur souhaite appeler l’API et filtrer par plusieurs ID et ownerEmail. Pour atteindre ce résultat, vous devez combiner l’ID d’étiquette et ownerEmail dans une seule clause booléenne.

Exemple

$filter=(
   (id eq 'guid1' and ownerEmail eq 'ownerEmail1')
  or (id eq 'guid2')
  or (id eq 'guid3' and ownerEmail eq 'ownerEmail2')
)

Ce $filter modèle est une extension de la spécification OData standard. Dans OData standard, la combinaison de plusieurs tuples avec or de cette manière n’est généralement pas prise en charge. Toutefois, cette API vous permet d’utiliser un modèle OU basé sur un tuple, où chaque (id, ownerEmail) paire est évaluée indépendamment et les informations de droits résultantes sont fusionnées. Pour plus d’informations sur le comportement standard d’OData $filter , consultez la spécification OData.

Nous vous recommandons d’utiliser des filtres qui utilisent un seul appel avec plusieurs ID pour récupérer les droits pour plusieurs étiquettes, car cela réduit le nombre d’appels d’API que vous devez effectuer à partir de votre application.

ownerEmail est facultatif et peut être omis pour récupérer uniquement les droits au niveau de l’étiquette.

Règles

  1. Modèle OU strict

    • Seule la structure basée sur le tuple combinée par des opérations OR comme indiqué ci-dessus est prise en charge.

    • Toute autre combinaison d’opérations OU ou de mélange de filtres non liés n’est pas autorisée et génère une ArgumentException.

  2. propriétaireValidation e-mail

    • ownerEmail doit toujours apparaître avec un id. L’utilisation ownerEmail de seul donne un ArgumentException.
  3. Exception OR interne

    • Vous pouvez combiner des clauses à l’aide de sous-clauses. Voici un exemple de sous-clause : (id eq 'guid1' and ownerEmail eq 'ownerEmail1')

    • Dans cet exemple, il y a trois sous-clauses. Lorsque vous combinez ID et ownerEmail, utilisez AND dans la sous-clause. N’utilisez pas OU, sinon cela lève une exception.

  4. Comportement du préfiltrage

    • Lorsque or cette option est utilisée, les paramètres et contentFormats (s’ils sont fournis) sont ignorés pour le locale préfiltrage.

Résumé du comportement

Cas Exemple Description
ID d’étiquette uniquement (id eq 'guid1') Retourne les droits définis sur l’étiquette.
ID d’étiquette + ownerEmail (id eq 'guid1' and ownerEmail eq 'ownerEmail1') Évalue les droits pour l’utilisateur spécifié.
Tuples multiples (id eq 'guid1' and ownerEmail eq 'ownerEmail1') or (id eq 'guid2') or (id eq 'guid3' and ownerEmail eq 'ownerEmail2') Combinez des conditions avec OU. Renvoie une liste fusionnée d’étiquettes et de droits pour toutes les étiquettes et tous les utilisateurs et étiquettes correspondants.

Scénario 3 : Étiquette de confidentialité droits/id/droits

Règles

  1. OU restriction avec ownerEmail

    • or Les opérations avec le paramètre ownerEmail filtre entraînent une exception.
  2. Exception OR interne

    • Les opérations internes or qui relèvent de l’arborescence de paramètres sont autorisées.

isScopedToUser Règles de paramètre

Cette section décrit le comportement et les contraintes du paramètre dans les API d’étiquette isScopedToUser de confidentialité.

Comportement des paramètres

isScopedToUser = true
  • Résultat : affiche uniquement les étiquettes activées
  • Cas d’utilisation : Filtrage Standard pour les étiquettes actives/activées
  • État : utilisation recommandée
isScopedToUser = false
  • Résultat : affiche uniquement les étiquettes désactivées
  • Cas d’utilisation : Limité ; idéalement pas utilisé avec cette valeur
  • État : Déconseillé pour les opérations classiques
isScopedToUser non passé
  • Résultat : affiche toutes les étiquettes (activées et désactivées)
  • Cas d’utilisation : Récupération complète des étiquettes
  • État : comportement par défaut lorsque le paramètre est omis

Restrictions

Exception d’étiquettes de client
  • Comportement : Lors de l’obtention d’étiquettes de client, l’utilisation de isScopedToUser will throw ArgumentException
  • Raison : le paramètre ne s’applique pas aux opérations d’étiquetage au niveau du locataire
  • Solution : Omettre le paramètre lors de l’utilisation d’étiquettes isScopedToUser de locataire

Relations

Relation Type Description
droits usageRightsIncluded Représente les droits d’utilisation (autorisations) configurés pour l’étiquette, le cas échéant.
sous-étiquettes collection microsoft.graph.security.sensitivityLabel Collection de sous-étiquettes associées à l’étiquette.

Représentation JSON

La représentation JSON suivante montre le type de ressource.

{
  "@odata.type": "#microsoft.graph.security.sensitivityLabel",
  "actionSource": "String",
  "applicableTo": "String",
  "applicationMode": "String",
  "assignedPolicies": [{"@odata.type": "microsoft.graph.labelPolicy"}],
  "autoLabeling": {"@odata.type": "microsoft.graph.autoLabeling"},
  "autoTooltip": "String",
  "color": "String",
  "description": "String",
  "displayName": "String",
  "hasProtection": "Boolean",
  "id": "String (identifier)",
  "isDefault": "Boolean",
  "isEnabled": "Boolean",
  "isEndpointProtectionEnabled": "Boolean",
  "isScopedToUser": "Boolean",
  "labelActions": [{"@odata.type": "microsoft.graph.encryptWithUserDefinedRights"}],
  "locale": "String",
  "name": "String",
  "priority": "Int32",
  "toolTip": "String"
}