group: validateProperties

名前空間: microsoft.graph

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

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

  1. プレフィックスとサフィックスの名前付けポリシーを検証する
  2. カスタム禁止単語ポリシーを検証する

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

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

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

アクセス許可

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

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

HTTP 要求

POST /groups/{id}/validateProperties

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json

要求本文

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

パラメーター 型 説明
displayName 文字列 検証するグループの表示名。 この物件は個別に必須ではありません。 ただし、少なくとも 1 つのプロパティ (displayName または mailNickname) は必須です。
mailNickname 文字列 検証するグループのメール ニックネーム。 この物件は個別に必須ではありません。 ただし、少なくとも 1 つのプロパティ (displayName または mailNickname) は必須です。
onBehalfOfUserId Guid API を呼び出すときに偽装するユーザーのオブジェクト ID。 検証結果は、onBehalfOfUserId の属性とロール用です。

応答

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

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

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

例

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

要求

POST https://graph.microsoft.com/beta/groups/{id}/validateProperties
Content-type: application/json

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

応答

HTTP/1.1 204 No Content

これは、検証エラーがある要求の例です。

要求

POST https://graph.microsoft.com/beta/groups/{id}/validateProperties
Content-type: application/json

{
  "displayName": "MyPrefix_test_mysuffix",
  "mailNickname": "MyPrefix_test_mysuffix"
}

応答

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": "id-value",
      "date": "date-value"
    },
    "details": [
      {
        "target": "mailNickname",
        "code": "PropertyConflict",
        "message": "Another object with the same value for property mailNickname already exists."
      }
    ]
  }
}
  • Last updated on