customSecurityAttributeDefinition を更新する

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

customSecurityAttributeDefinition オブジェクトのプロパティを更新します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) CustomSecAttributeDefinition.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション CustomSecAttributeDefinition.ReadWrite.All 注意事項なし。

サインインしたユーザーには、少なくとも 属性定義管理者ディレクトリ ロールも割り当てる必要があります。 既定では、 グローバル管理者 やその他の管理者ロールには、カスタム セキュリティ属性の読み取り、定義、または割り当てに対するアクセス許可がありません。

HTTP 要求

PATCH /directory/customSecurityAttributeDefinitions/{customSecurityAttributeDefinitionId}

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-Type application/json. Required.
OData-Version 4.01. 省略可能です。

注:

カスタム セキュリティ属性の定義済みの値を更新するには、 OData-Version ヘッダーを追加し、値 4.01を割り当てる必要があります。

要求本文

要求本文で、更新すべきプロパティの値のみを指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

プロパティ 型 説明
description String カスタム セキュリティ属性の説明。 最大 128 文字の長さと Unicode 文字を含めることができます。 省略可能です。
status String カスタム セキュリティ属性がアクティブか非アクティブかを指定します。 許容される値は Available と Deprecatedです。 省略可能です。
usePreDefinedValuesOnly ブール型 定義済みの値のみをカスタム セキュリティ属性に割り当てることができるかどうかを示します。 に設定すると false、自由形式の値が許可されます。 から にfalse変更できますが、 から truefalse にtrue変更することはできません。 型が にBoolean設定されている場合、usePreDefinedValuesOnly を にtrue設定することはできません。 省略可能。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返します。

例

例 1: カスタム セキュリティ属性を更新する

次の例では、カスタム セキュリティ属性定義の説明を更新します。

  • 属性セット: Engineering
  • 属性: ProjectDate

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/beta/directory/customSecurityAttributeDefinitions/Engineering_ProjectDate
Content-Type: application/json

{
  "description": "Target completion date (YYYY/MM/DD)",
}

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content

例 2: カスタム セキュリティ属性の定義済みの値を更新する

次の例では、既存の定義済み値の状態を更新し、カスタム セキュリティ属性定義の新しい定義済み値を追加します。

  • 属性セット: Engineering
  • 属性: Project
  • 属性データ型: 文字列のコレクション
  • 定義済みの値を更新します。 Baker
  • 新しい定義済み値: Skagit

注:

この要求では、 OData-Version ヘッダーを追加し、値 4.01を割り当てる必要があります。

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/beta/directory/customSecurityAttributeDefinitions/Engineering_Project
Content-Type: application/json
OData-Version: 4.01

{
    "allowedValues@delta": [
        {
            "id": "Baker",
            "isActive": false
        },
        {
            "id": "Skagit",
            "isActive": true
        }
    ]
}

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content

例 3: カスタム セキュリティ属性を非アクティブ化する

次の例では、カスタム セキュリティ属性定義を非アクティブ化します。

  • 属性セット: Engineering
  • 属性: Project

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/beta/directory/customSecurityAttributeDefinitions/Engineering_Project
Content-Type: application/json

{
  "status": "Deprecated"
}

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content