Обновление userConfiguration

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

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Обновите свойства объекта userConfiguration .

Разрешения

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

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

HTTP-запрос

PATCH /me/mailFolders/{mailFolderId}/userConfigurations/{userConfigurationId}
PATCH /users/{usersId}/mailFolders/{mailFolderId}/userConfigurations/{userConfigurationId}

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

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

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

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

В следующей таблице указаны свойства, которые можно обновить.

Свойство	Тип	Описание
binaryData	Binary	Произвольные двоичные данные. Необязательный параметр.
structuredData	коллекция structuredDataEntry	Пары "ключ-значение" поддерживаемых типов данных. Необязательный параметр.
xmlData	Binary	Двоичные данные для хранения сериализованного XML-кода. Необязательный параметр.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 200 OK и обновленный объект userConfiguration в тексте отклика.

Примеры

Запрос

Ниже показан пример запроса.

Примечание: Обновляется весь объект structuredData .

HTTP

PATCH https://graph.microsoft.com/beta/me/mailFolders/inbox/userConfigurations/MyApp
Content-Type: application/json

{
  "structuredData": [
    {
      "keyEntry":
      {
        "type": "string",
        "values": [
          "name"
        ]
      },
      "valueEntry":
      {
        "type": "string",
        "values": [
          "Snow"
        ]
      }
    }
  ]
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const userConfiguration = {
  structuredData: [
    {
      keyEntry: 
      {
        type: 'string',
        values: [
          'name'
        ]
      },
      valueEntry: 
      {
        type: 'string',
        values: [
          'Snow'
        ]
      }
    }
  ]
};

await client.api('/me/mailFolders/inbox/userConfigurations/MyApp')
	.version('beta')
	.update(userConfiguration);

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже показан пример отклика.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
   "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('f42c50f8-1300-48a0-93d4-6481acda7efb')/mailFolders('inbox')/userConfigurations/$entity",
  "structuredData": [
    {
      "@odata.type": "microsoft.graph.structuredDataEntry"
    }
  ]
}