Skip to content

group-validateproperties.md

Latest commit

 

History

History
180 lines (132 loc) · 6.87 KB

group-validateproperties.md

File metadata and controls

180 lines (132 loc) · 6.87 KB
title group: validateProperties
description Validate if a Microsoft 365 group's display name or mail nickname complies with naming policies.
ms.localizationpriority medium
author yuhko-msft
ms.reviewer mbhargav, khotzteam, aadgroupssg
ms.subservice entra-groups
doc_type apiPageType
ms.date 11/30/2024

group: validateProperties

Namespace: microsoft.graph

Validate if a Microsoft 365 Group's display name or mail nickname complies with naming policies. Clients can use the API to determine if a display name or mail nickname is valid before trying to update a Microsoft 365 Group. 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

This API returns with the first failure encountered. 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're only validating the prefix and suffix naming policy.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

POST /groups/{id}/validateProperties

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
displayName String The display name of the group to validate. The property isn't individually required. However, at least one property (displayName or mailNickname) is required.
mailNickname String The mail nickname of the group to validate. The property isn't individually required. However, at least one property (displayName or mailNickname) is required.
onBehalfOfUserId Guid The object ID of the user to impersonate when calling the API. The validation results are for the onBehalfOfUserId's attributes and roles.

Response

If successful and there are no validation errors, the method returns 204 No Content response code. It doesn't return anything in the response body.

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's 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

This is an example of a successful validation request.

Request

HTTP

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

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

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

HTTP/1.1 204 No Content

This is an example of a request with validation errors.

Request

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

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

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