フィードバック 編集

directoryObject: validateProperties

  • [アーティクル]

名前空間: microsoft.graph

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

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

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

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

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

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

HTTP 要求

POST /directoryObjects/validateProperties

要求ヘッダー

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

要求本文

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

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

応答

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

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

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

例

例 1: 検証要求の成功

これは、検証要求の成功例です。

要求

POST https://graph.microsoft.com/v1.0/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

例 2: 検証エラーのある要求

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

要求

POST https://graph.microsoft.com/v1.0/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"
      }
    ]
  }
}