directoryObject: validateProperties

名前空間: microsoft.graph

Microsoft 365 グループの表示名またはメールのニックネームが名前付けポリシーに準拠していることを検証します。 クライアントは、Microsoft 365 グループを 作成 する前に、この API を使用して、表示名またはメールのニックネームが有効かどうかを判断できます。 既存のグループのプロパティを検証するには、グループの validateProperties 関数 を使用します。

表示名プロパティとメール ニックネーム プロパティに対して、次の検証が実行されます。

  1. プレフィックスとサフィックスの名前付けポリシーを検証する
  2. カスタム禁止単語ポリシーを検証する
  3. メールのニックネームが一意であることを検証する

この API は、最初に発生したエラーを返します。 1 つ以上のプロパティが複数の検証に失敗した場合、最初の検証エラーが発生したプロパティのみが返されます。 ただし、プレフィックスとサフィックスの名前付けポリシーのみを検証している場合は、メールのニックネームと表示名の両方を検証し、検証エラーのコレクションを受け取ることができます。

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

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

アクセス許可

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

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

HTTP 要求

POST /directoryObjects/validateProperties

要求ヘッダー

名前 説明
Authorization ベアラー {code}。 必須です。
Content-Type application/json. 必須です。

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

パラメーター 説明
Entitytype 文字列 Group は、サポートされている唯一のエンティティ型です。
displayName String 検証するグループの表示名。 プロパティは個別に必要ありません。 ただし、少なくとも 1 つのプロパティ (displayName または mailNickname) が必要です。
mailNickname String 検証するグループのメール ニックネーム。 プロパティは個別に必要ありません。 ただし、少なくとも 1 つのプロパティ (displayName または mailNickname) が必要です。
onBehalfOfUserId Guid API を呼び出すときに偽装するユーザーのオブジェクト ID。 検証結果は、onBehalfOfUserId の属性とロールを対象とします。

応答

成功し、検証エラーがない場合、メソッドは応答コードを返します 204 No Content 。 応答本文では何も返されません。

要求が無効な場合、メソッドは応答コードを返します 400 Bad Request 。 無効な要求に関する詳細を含むエラー メッセージが応答本文に返されます。

検証エラーが発生した場合、メソッドは応答コードを返します 422 Unprocessable Entity 。 エラー メッセージとエラーの詳細のコレクションが応答本文に返されます。

これは、検証要求が成功した例です。

要求

POST https://graph.microsoft.com/beta/directoryObjects/validateProperties
Content-type: application/json

{
  "entityType": "Group",
  "displayName": "Myprefix_test_mysuffix",
  "mailNickname": "Myprefix_test_mysuffix",
  "onBehalfOfUserId": "onBehalfOfUserId-value"
}

応答

HTTP/1.1 204 No Content

これは、検証エラーが発生した要求の例です。

要求

POST https://graph.microsoft.com/beta/directoryObjects/validateProperties
Content-type: application/json

{
  "entityType": "Group",
  "displayName": "test",
  "mailNickname": "test",
  "onBehalfOfUserId": "onBehalfOfUserId-value"
}

応答

HTTP/1.1 422 
Content-Type: application/json

{
  "error": {
    "code": "Request_UnprocessableEntity",
    "message": "The values provided contain one or more validation errors.",
    "innerError": {
      "request-id": "request-id-value",
      "date": "date-value"
    },
    "details": [
      {
        "target": "displayName",
        "code": "MissingPrefixSuffix",
        "message": "Property mailNickname is missing a required prefix/suffix per your organization's Group naming requirements.",
        "prefix": "Myprefix_",
        "suffix": "_mysuffix"
      },
      {
        "target": "mailNickname",
        "code": "MissingPrefixSuffix",
        "message": "Property mailNickname is missing a required prefix/suffix per your organization's Group naming requirements.",
        "prefix": "Myprefix_",
        "suffix": "_mysuffix"
      }
    ]
  }
}