directoryObject: validateProperties

  • Статья

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

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

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

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

Примечание.

Недопустимые символы не являются частью проверки политики. Недопустимы следующие символы: @ () \ [] " ; : <> , ПРОБЕЛ.

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

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

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

Разрешения

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

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

HTTP-запрос

POST /directoryObjects/validateProperties

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

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json

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

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

Параметр Тип Описание
Entitytype String Группа — единственный поддерживаемый тип сущности.
displayName String Отображаемое имя группы для проверки. Свойство не является обязательным по отдельности. Однако требуется по крайней мере одно свойство (displayName или mailNickname).
mailNickname String Почтовый псевдоним группы для проверки. Свойство не является обязательным по отдельности. Однако требуется по крайней мере одно свойство (displayName или mailNickname).
onBehalfOfUserId GUID Идентификатор пользователя, олицетворяемого при вызове API. Результаты проверки относятся к атрибутам и ролям onBehalfOfUserId .

Отклик

В случае успешного выполнения и отсутствия ошибок проверки метод возвращает 204 No Content код ответа. Он не возвращает ничего в теле ответа.

Если недопустимый запрос, метод возвращает 400 Bad Request код ответа. В тексте ответа возвращается сообщение об ошибке с подробными сведениями о недопустимом запросе.

Если возникает ошибка проверки, метод возвращает 422 Unprocessable Entity код ответа. В тексте ответа возвращается сообщение об ошибке и коллекция сведений об ошибке.

Примеры

Пример 1. Успешный запрос на проверку

Это пример успешного запроса на проверку.

Запрос

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

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

Отклик

HTTP/1.1 204 No Content

Пример 2. Запрос с ошибками проверки

Это пример запроса с ошибками проверки.

Запрос

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

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

Отклик

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