directoryObject: validatePropertiesdirectoryObject: validateProperties

名前空間: microsoft.graphNamespace: microsoft.graph

Microsoft 365 グループの表示名またはメールのニックネームが名前付けポリシーに準拠していることを検証します。Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. クライアントは、この API を使用して、Microsoft 365 グループを 作成 する前に表示名またはメールニックネームが有効かどうかを判断します。Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. 既存のグループのプロパティを検証するには、 group: validateProperties 関数を使用します。To validate the properties of an existing group, use the group: validateProperties function.

[表示名] および [メールニックネーム] プロパティに対して、次のポリシー検証が実行されます。The following policy 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
  3. メールニックネームが一意であることを確認するValidate that the mail nickname is unique

この API は、検出された最初の検証エラーのみを返します。This API only returns the first validation failure that is encountered. プロパティが複数の検証に失敗した場合は、最初の検証エラーのみが返されます。If the properties fail multiple validations, only 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. 名前付けポリシーの構成の詳細については、「 Configure ネーミング policy」を参照してください。To learn more about configuring naming policies, see Configure 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、Directory.Read.All、Directory.ReadWrite.All、Directory.AccessAsUser.AllGroup.Read.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication Group.Read.All、Group.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.AllGroup.Read.All, Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All

HTTP 要求HTTP request

POST /directoryObjects/validateProperties

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
Content-TypeContent-Type application/jsonapplication/json

要求本文Request body

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

パラメーターParameter 種類Type 説明Description
entityTypeentityType 文字列String Group は、サポートされている唯一のエンティティの種類です。Group is the only supported entity type.
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 文字列String 検証するグループのメールニックネーム。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 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.

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

Examples

例 1: 正常な検証要求Example 1: Successful validation request

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

要求Request

POST https://graph.microsoft.com/v1.0/directoryObjects/validateProperties
Content-type: application/json
Content-length: 164

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

応答Response

HTTP/1.1 204 No Content

例 2: 検証エラーがある要求Example 2: Request with validation errors

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

要求Request

POST https://graph.microsoft.com/v1.0/directoryObjects/validateProperties
Content-type: application/json
Content-length: 164

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

応答Response

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