update customSecurityAttributeDefinition

名前空間: microsoft.graph

重要

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

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

アクセス許可

この 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 Boolean 定義済みの値のみをカスタム セキュリティ属性に割り当て可能かどうかを示します。 false に設定すると、自由形式の値を使用できます。 true から false に変更できますが、false から true に変更することはできません。 ブール type 型 (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