名前空間: microsoft.graph.security
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
情報に秘密度ラベルを適切に適用する方法を詳しく説明する情報保護ラベルについて説明します。 informationProtectionLabel リソースは、ユーザーまたはテナントに適用される秘密度ラベルの構成を記述します。
メソッド
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| actionSource | microsoft.graph.security.labelActionSource | ラベルが適用される原因となったアクションのソースを示します。 使用可能な値: manual、automatic、recommended、none。 |
| autoLabeling | autoLabeling | ラベルの自動ラベル付け構成。 |
| applicableTo | microsoft.graph.security.sensitivityLabelTarget | ラベルを適用できるワークロードを指定します。 可能な値: email、 site、 unifiedGroup、 teamwork、 file、 schematizedData。 |
| applicationMode | microsoft.graph.security.applicationMode | ラベルの適用または推奨の方法を指定します。 使用可能な値: manual、automatic、recommended。 |
| assignedPolicies | labelPolicy コレクション | ラベルに割り当てられているラベル ポリシーのコレクション。 |
| autoTooltip | 文字列 | 推奨ラベルや自動的に適用されるラベルについてユーザーに表示されるヒント。 |
| color | String | ラベルに対して UI に表示する色 (構成されている場合)。 |
| contentFormats | String collection | ラベルでサポートされているコンテンツ形式を返します。 |
| 説明 | String | 管理者が定義したラベルの説明。 |
| displayName | 文字列 | 秘密度ラベルの表示名。 |
| hasProtection | ブール型 | ラベルに保護アクション ( 暗号化 や 転送不可など) が構成されているかどうかを示します。 |
| id | 文字列 | ラベル ID はグローバル一意識別子 (GUID) です。 |
| isActive | ブール型 | ラベルがアクティブかどうかを示します。 アクティブなラベルは、UI で非表示または無効にする必要があります。 |
| isAppliable | ブール型 | ラベルをコンテンツに適用できるかどうかを示します。
False ラベルが子ラベルを持つ親ラベルの場合。 |
| isDefault | ブール型 |
true ラベルがポリシーの既定のラベルの場合。それ以外の場合は false 。 |
| isEnabled | ブール値 |
true ラベルが現在有効になっている場合。それ以外の場合は false 。 |
| isEndpointProtectionEnabled | ブール型 |
true ラベルがエンドポイント データ損失防止によって適用される保護設定を提供する場合。それ以外の場合は false 。 |
| isScopedToUser | ブール型 | ラベルが特定のユーザーまたはグループ (true) に限定されているか、テナント全体が使用できるか (false) かを示します。 |
| labelActions | labelActionBase コレクション | ラベルに関連付けられているアクション。 |
| ロケール | 文字列 | ラベルのローカライズされたプロパティに関連付けられているロケール (例: 'en-US')。 ユーザー/ロケールを対象とするラベルを一覧表示するコンテキストで使用されます。 |
| name | String | ラベルのプレーンテキスト名。 |
| priority | Int32 | ラベルの優先順位。 数値が小さいほど優先度が高いことを示します。 |
| sensitivity | Int32 | ラベルの秘密度の値 (低いほど感度が低い)。 |
| tooltip | 文字列 | UI のラベルに対して表示するヒント。 |
秘密度ラベル API フィルター規則
このセクションでは、さまざまな秘密度ラベル API 呼び出しに適用できるフィルタールールと制約について説明します。
シナリオ 1: 秘密度ラベル (1 つ以上) を返す
ユーザーは API を呼び出し、1 つ以上のラベル ID GUID でフィルター処理します。
例
$filter=((id eq 'guid1') or (id eq 'guid2') or (id eq 'guid3'))
ルール
isScopedToUser を使用した OR 制限
-
isScopedToUserフィルター パラメーターが存在する場合、フィルター パラメーターでorは許可されません
-
OR による事前フィルター動作
- フィルター パラメーターに
orが存在する場合、localeフィルター パラメーターとcontentFormatsフィルター パラメーター (存在する場合) はプリフィルター処理に使用されません
- フィルター パラメーターに
内部 OR 例外
- パラメーター ツリーに該当する内部
or操作は許可されます
- パラメーター ツリーに該当する内部
シナリオ 2: 単一の ID とユーザー権利のフィルターを使用して秘密度ラベルの結果を返す
ユーザーは API を呼び出し、1 つのラベル ID GUID と 1 つのユーザー権利でフィルター処理します。
例
$filter=(id eq 'guid1' and ownerEmail eq 'ownerEmail1')
ルール
複数パラメーターを使用した OR 制限
- フィルター パラメーターが
isScopedToUser、id、またはownerEmailのいずれかに当てはまる場合、フィルター パラメーターでorは許可されません
- フィルター パラメーターが
ownerEmail の検証
-
ownerEmailidなしで存在すると、ArgumentExceptionスローされます。
-
OR による事前フィルター動作
- $filter文字列に
orが存在する場合、localeおよびcontentFormatsフィルター パラメーターは無視され、結果の事前フィルター処理には使用されません。
- $filter文字列に
内部 OR 例外
- 個々の句の間で内部
or演算を使用できます。
- 個々の句の間で内部
シナリオ 2.5: 複数の ID とユーザー権利のフィルターを使用して秘密度ラベルの結果を返す
ユーザーは API を呼び出し、複数の ID と ownerEmail でフィルター処理しようとしています。 この結果を得るには、1 つのブール句でラベル ID と ownerEmail の両方を組み合わせる必要があります。
例
$filter=(
(id eq 'guid1' and ownerEmail eq 'ownerEmail1')
or (id eq 'guid2')
or (id eq 'guid3' and ownerEmail eq 'ownerEmail2')
)
この $filter パターンは、標準 OData 仕様の拡張機能です。 標準の OData では、この方法で複数のタプルを or と組み合わせることは、通常サポートされていません。 ただし、この API では、各 (id, ownerEmail) ペアが個別に評価され、結果の権利情報がマージされるタプルベースの OR パターンを使用できます。 標準的な OData $filter 動作の詳細については、 OData 仕様を参照してください。
複数の ID で単一の呼び出しを使用するフィルターを使用し、複数のラベルの権限を取得することをお勧めします。これにより、アプリから行う必要のある API 呼び出しの数が削減されるためです。
ownerEmail は省略可能であり、ラベル レベルの権限のみをフェッチするために省略できます。
ルール
厳密な OR パターン
上記のように、OR 演算によって組み合わせられたタプルベースの構造のみがサポートされています。
OR 演算の他の組み合わせや、関連のないフィルターの混合は許可されず、ArgumentException が発生します。
ownerEmail の検証
-
ownerEmail必ずidと一緒に表示する必要があります。ownerEmail単独で使用すると、ArgumentExceptionが発生します。
-
内部 OR 例外
サブ句を使用して句を組み合わせることができます。 サブ句の例を次に示します: (id eq 'guid1' and ownerEmail eq 'ownerEmail1')
この例には、3 つのサブ句があります。 ID と ownerEmail を組み合わせる場合は、サブ句で AND を使用します。 OR を使用しないでください。それ以外の場合は、例外をスローします。
事前フィルタリング動作
-
orを使用すると、localeパラメーターとcontentFormatsパラメーター (指定された場合) は、プリフィルター処理では無視されます。
-
動作の概要
| ケース | 例 | 説明 |
|---|---|---|
| ラベル ID のみ | (id eq 'guid1') |
ラベルに定義された権利を返します。 |
| ラベル ID + 所有者メール アドレス | (id eq 'guid1' and ownerEmail eq 'ownerEmail1') |
指定されたユーザーの権利を評価します。 |
| 複数のタプル | (id eq 'guid1' and ownerEmail eq 'ownerEmail1') or (id eq 'guid2') or (id eq 'guid3' and ownerEmail eq 'ownerEmail2') |
条件と OR を組み合わせる。 一致したすべてのラベルとユーザーのラベルと権利のマージされた一覧を返します。 |
シナリオ 3: 秘密度ラベルの権利 /id/rights
ルール
ownerEmail を使用した OR 制限
-
orフィルター パラメーターをownerEmailした操作では例外が発生します。
-
内部 OR 例外
- パラメーター ツリーに該当する内部
or操作が許可されます。
- パラメーター ツリーに該当する内部
isScopedToUser パラメーター ルール
このセクションでは、秘密度ラベル API の isScopedToUser パラメーターの動作と制約について説明します。
パラメーターの動作
isScopedToUser = true
- 結果: 有効なラベルのみを表示する
- ユース ケース: アクティブ/有効ラベルの Standard フィルター
- 状態: 推奨される使用方法
isScopedToUser = false
- 結果: 無効なラベルのみを表示する
- ユース ケース: 制限付き - この値では使用しないのが理想的です
- 状態: 通常の操作には推奨されません
isScopedToUser が渡されない
- 結果: すべてのラベル (有効と無効の両方) を表示する
- ユース ケース: 包括的なラベル取得
- 状態: パラメーターを省略した場合の既定の動作
制限
テナント ラベルの例外
-
動作: テナント ラベルを取得するときに、
isScopedToUserを使用すると、ArgumentException - 理由: パラメーターはテナント レベルのラベル操作には適用されません
-
解決策: テナント ラベルを操作するときに
isScopedToUserパラメーターを省略する
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| rights | usageRightsIncluded | ラベルに設定されている使用権 (アクセス許可) を表します (存在する場合)。 |
| サブラベル | microsoft.graph.security.sensitivityLabel コレクション | ラベルに関連付けられているサブラベルのコレクション。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@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"
}