グループ: validatePropertiesgroup: validateProperties

Office 365 グループの表示名またはメールニックネームが名前付けポリシーに準拠しているかどうかを検証します。Validate if an Office 365 group's display name or mail nickname complies with naming policies. クライアントは API を使用して、Office 365 グループの更新を試行する前に、表示名またはメールニックネームが有効かどうかを判断します。Clients can use the API to determine if a display name or mail nickname is valid before trying to update an Office 365 group. グループを作成する前にプロパティを検証するには、ディレクトリオブジェクトに対してvalidateproperties 関数を使用します。For validating properties before creating a group, use the validateProperties function for directory objects.

[表示名] および [メールニックネーム] プロパティに対して、次の検証が実行されます。The following validations are performed for the display name and mail nickname properties:

  1. プレフィックスとサフィックスの名前付けポリシーを検証するValidate the prefix and suffix naming policy
  2. カスタムの禁止単語のポリシーを検証するValidate the custom banned words policy

この API は、最初のエラーが発生したことを返します。This API returns with the first failure encountered. 1つ以上のプロパティが複数の検証に失敗した場合、最初の検証に失敗したプロパティのみが返されます。If one or more properties fail multiple validations, only the property with the first validation failure is returned. ただし、プレフィックスとサフィックスの名前付けポリシーのみを検証する場合は、メールニックネームと表示名の両方を検証し、検証エラーのコレクションを受信することができます。However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Group.Read.All、Group.ReadWrite.AllGroup.Read.All, Group.ReadWrite.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication Group.Read.All、Group.ReadWrite.AllGroup.Read.All, Group.ReadWrite.All

HTTP 要求HTTP request

POST /groups/<id>/validateProperties

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization Bearer {code}Bearer {code}
Content-TypeContent-Type application/jsonapplication/json

要求本文Request body

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。In the request body, provide a JSON object with the following parameters.

パラメーターParameter Type 説明Description
displayNamedisplayName 文字列String 検証するグループの表示名。The display name of the group to validate. プロパティが個別に必要ではありません。The property is not individually required. ただし、少なくとも1つのプロパティ (displayName または mailNickname) が必要です。However, at least one property (displayName or mailNickname) is required.
mailNicknamemailNickname StringString 検証するグループのメールニックネーム。The mail nickname of the group to validate. プロパティが個別に必要ではありません。The property is not individually required. ただし、少なくとも1つのプロパティ (displayName または mailNickname) が必要です。However, at least one property (displayName or mailNickname) is required.
onBehalfOfUserIdonBehalfOfUserId GuidGuid API を呼び出すときに偽装するユーザーのオブジェクト ID。The object ID of the user to impersonate when calling the API. 検証結果は、onBehalfOfUserId の属性とロールに対して行われます。The validation results are for the onBehalfOfUserId's attributes and roles.

応答Response

成功した場合、検証エラーがない場合、メソッド204 No Contentは応答コードを返します。If successful and there are no validation errors, the method returns 204 No Content response code. 応答本文には何も返されません。It does not return anything in the response body.

要求が無効である場合、メソッドは400 Bad Request応答コードを返します。If the request is invalid, the method returns 400 Bad Request response code. 無効な要求に関する詳細を含むエラーメッセージが応答本文で返されます。An error message with details about the invalid request is returned in the response body.

検証エラーが発生した場合。If there is a validation error. メソッドは応答422 Unprocessable Entityコードを返します。The method returns 422 Unprocessable Entity response code. エラーメッセージとエラーの詳細のコレクションが応答本文で返されます。An error message and a collection of error details is returned in the response body.

Examples

これは、正常な検証要求の例です。This is an example of a successful validation request.

要求Request

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

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

応答Response

HTTP/1.1 204 No Content

SDK サンプルコードSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var displayName = "Myprefix_test_mysuffix";

var mailNickname = "Myprefix_test_mysuffix";

var onBehalfOfUserId = "onBehalfOfUserId-value";

await graphClient.Groups["{id}"]
    .ValidateProperties(displayName,mailNickname,onBehalfOfUserId)
    .Request()
    .PostAsync();

SDK をプロジェクトに追加し、 authproviderインスタンスを作成する方法の詳細については、 sdk のドキュメントを参照してください。Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.

これは、検証エラーが発生した要求の例です。This is an example of a request with validation errors.

要求Request

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

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

応答Response

HTTP/1.1 422
Content-type: application/json
Content-length: 223

{
  "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."
      }
    ]
  }
}