Поделиться через


Создание соглашения

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

Создайте новый объект соглашения .

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

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

Разрешения

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

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

HTTP-запрос

POST /identityGovernance/termsOfUse/agreements

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

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

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

В тексте запроса укажите представление объекта соглашения в формате JSON.

В следующей таблице показаны свойства, необходимые при создании соглашения.

Свойство Тип Описание
displayName String Отображаемое имя соглашения.
isViewingBeforeAcceptanceRequired Логический Указывает, должен ли пользователь развернуть и просмотреть соглашение перед принятием.
fileName String Имя файла соглашения (например, TOU.pdf).
isDefault Логический Указывает, является ли этот файл соглашения по умолчанию, если язык соответствует предпочтениям клиента. Если ни один из файлов не помечен как по умолчанию, первый из них обрабатывается как по умолчанию.
language String Язык файла соглашения в формате languagecode2-country/regioncode2. "languagecode2" — это двухбуквенный код в нижнем регистре, производный от ISO 639-1, а "country/regioncode2" является производным от ISO 3166 и обычно состоит из двух прописных букв или тега языка BCP-47. Например, английский (США) — .en-US
data В двоичном формате Данные, представляющие условия использования pdf-документа.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 201, Created и объект соглашения в тексте отклика.

Пример

Запрос

В тексте запроса укажите представление объекта соглашения в формате JSON.

POST https://graph.microsoft.com/v1.0/identityGovernance/termsOfUse/agreements
Content-type: application/json

{
  "displayName": "Contoso ToU for guest users",
  "isViewingBeforeAcceptanceRequired": true,
  "files": [
    {
      "fileName": "TOU.pdf",
      "language": "en",
      "isDefault": true,
      "fileData": {
        "data": "SGVsbG8gd29ybGQ=//truncated-binary"
      }
    }
  ]
}

Отклик

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 201 Created
Content-type: application/json

{
  "displayName": "MSGraph Sample",
  "isViewingBeforeAcceptanceRequired": true,
  "id": "093b947f-8363-4979-a47d-4c52b33ee1be"
}