Тип ресурса соглашения
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Представляет настраиваемое соглашение об условиях использования клиента, которое создается и управляется с помощью Управление Microsoft Entra ID. Вы можете использовать следующие методы для создания функции Microsoft Entra Условий использования и управления ею в соответствии с вашим сценарием.
Методы
Метод | Возвращаемый тип | Описание |
---|---|---|
Создание | соглашение | Создайте новое соглашение, опубликовав его в коллекции соглашений. |
List | сбор соглашений | Получение коллекции объектов соглашения. |
Получение | соглашение | Чтение свойств и связей объекта соглашения. |
Обновление | Нет | Обновление объекта соглашения. |
удаление; | Нет | Удаление объекта соглашения. |
Свойства
Свойство | Тип | Описание |
---|---|---|
displayName | String | Отображаемое имя соглашения. Отображаемое имя используется для внутреннего отслеживания соглашения, но не отображается конечным пользователям, которые просматривают соглашение. Поддерживает $filter (eq ). |
id | String | Только для чтения. Поддерживает $filter (eq ). |
isPerDeviceAcceptanceRequired | Логический | Этот параметр позволяет требовать от конечных пользователей принять данное соглашение на каждом устройстве, с которых они получают к нему доступ. Пользователь должен зарегистрировать свое устройство в Microsoft Entra ID, если он еще этого не сделал. Поддерживает $filter (eq ). |
isViewingBeforeAcceptanceRequired | Логический | Указывает, должен ли пользователь развернуть соглашение перед принятием. Поддерживает $filter (eq ). |
termsExpiration | termsExpiration | Срок действия и частота соглашения для всех пользователей. Поддерживает $filter (eq ). |
userReacceptRequiredFrequency | Duration (Длительность) | Длительность, по истечении которой пользователь должен повторно принять условия использования. Значение представлено в формате ISO 8601 для длительности. |
Связи
Связь | Тип | Описание |
---|---|---|
Акцепты | Коллекция agreementAcceptance | Только для чтения. Сведения о принятии настоящего соглашения. |
file | agreementFile | PDF-файл по умолчанию, связанный с этим соглашением. |
files | коллекция agreementFileLocalization | PDF-файлы, связанные с этим соглашением. Примечание: Это свойство находится в процессе нерекомендуемого использования. Вместо этого используйте свойство file . |
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"@odata.type": "#microsoft.graph.agreement",
"id": "String (identifier)",
"displayName": "String",
"termsExpiration": {
"@odata.type": "microsoft.graph.termsExpiration"
},
"userReacceptRequiredFrequency": "String (duration)",
"isViewingBeforeAcceptanceRequired": "Boolean",
"isPerDeviceAcceptanceRequired": "Boolean"
}