group: validateProperties

  • Статья

Пространство имен: microsoft.graph

Проверьте, соответствует ли отображаемое имя или псевдоним электронной почты группе Microsoft 365 политикам именования. Клиенты могут использовать API для определения допустимости отображаемого имени или почтового псевдонима, прежде чем пытаться обновить группу Microsoft 365. Для проверки свойств перед созданием группы используйте функцию validateProperties для объектов каталога.

Для свойств отображаемого имени и почтового псевдонима выполняются следующие проверки:

  1. Проверка политики именования префикса и суффикса
  2. Проверка настраиваемой политики запрещенных слов

Этот API возвращается с первым возникшим сбоем. Если одно или несколько свойств не прошли несколько проверок, возвращается только свойство с первым сбоем проверки. Однако вы можете проверить как псевдоним почты, так и отображаемое имя и получить коллекцию ошибок проверки, если вы проверяете только политику именования префикса и суффикса.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet
✅ ✅ ✅ ✅

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) Group.Read.All Group.ReadWrite.All
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Для приложений Group.Read.All Group.ReadWrite.All

HTTP-запрос

POST /groups/{id}/validateProperties

Заголовки запросов

Имя Описание
Авторизация Bearer {code}
Content-Type application/json

Текст запроса

В тексте запроса предоставьте JSON-объект с указанными ниже параметрами.

Параметр Тип Описание
displayName String Отображаемое имя группы для проверки. Свойство не является обязательным по отдельности. Однако требуется по крайней мере одно свойство (displayName или mailNickname).
mailNickname String Почтовый псевдоним группы для проверки. Свойство не является обязательным по отдельности. Однако требуется по крайней мере одно свойство (displayName или mailNickname).
onBehalfOfUserId GUID Идентификатор объекта пользователя, олицетворяемого при вызове API. Результаты проверки относятся к атрибутам и ролям 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."
      }
    ]
  }
}