Обновление приложения

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

Обновление свойств объекта приложения .

Важно!

Использование метода PATCH для настройки passwordCredential не поддерживается. Используйте методы addPassword и removePassword , чтобы обновить пароль или секрет для приложения.

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

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

Разрешения

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

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

HTTP-запрос

Вы можете обратиться к приложению, используя его идентификатор или appId. Id и appId называются идентификатором объекта и идентификатором приложения (клиента) соответственно в регистрации приложений в Центре администрирования Microsoft Entra. Замените {applicationObjectId}идентификатором объекта приложения.

PATCH /applications/{applicationObjectId}
PATCH /applications(appId='{appId}')

Чтобы обновить логотип, используйте метод PUT, как показано ниже.

PUT /applications/{applicationObjectId}/logo
PUT /applications(appId='{appId}')/logo

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

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

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

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

Свойство Тип Описание
api apiApplication Задает параметры приложения, реализующего веб-API.
appRoles Коллекция appRole Коллекция ролей, определенных для приложения. Эти роли могут назначаться пользователям, группам или субъектам-службам. Значение null не допускается.
displayName String Отображаемое имя приложения.
groupMembershipClaims String Настраивает утверждение группы , выданное в маркере доступа пользователя или OAuth 2.0, которое ожидает приложение. Чтобы задать этот атрибут, используйте одно из следующих допустимых строковых значений.
  • None
  • SecurityGroup: для групп безопасности и ролей Microsoft Entra
  • All: будут получаться все группы безопасности, группы рассылки и роли каталога Microsoft Entra, членом которыми является пользователь, выполнившего вход.
identifierUris Коллекция String URI, которые идентифицируют приложение в клиенте Microsoft Entra или в проверенном пользовательском домене, если приложение является мультитенантным. Дополнительные сведения см. в разделе Объекты приложения и субъекта-службы. Для выражений фильтра в случае многозначных свойств требуется оператор any. Значение null не допускается.
info informationalUrl Основные сведения о профиле приложения, такие как маркетинг приложения, поддержка, условия обслуживания и URL-адреса заявлений о конфиденциальности. Условия обслуживания и заявление о конфиденциальности отображаются в окне запроса согласия пользователя. Дополнительные сведения см. в статье Добавление условий обслуживания и заявления о конфиденциальности для зарегистрированных приложений Microsoft Entra.
isFallbackPublicClient Boolean Указывает резервный тип приложения как общедоступный клиент, например установленное приложение, запущенное на мобильном устройстве. Значение по умолчанию — false, что означает, что резервный тип приложения является конфиденциальным клиентом, например веб-приложением. Существуют определенные сценарии, в которых идентификатор Microsoft Entra не может определить тип клиентского приложения (например, поток ROPC , в котором он настроен без указания URI перенаправления). В таких случаях идентификатор Microsoft Entra интерпретирует тип приложения на основе значения этого свойства.
keyCredentials Коллекция keyCredential Коллекция ключевых учетных данных, связанных с приложением. Значение null не допускается.
logo Stream Основной логотип для приложения. Значение null не допускается. Используйте метод PUT для обновления логотипа.
nativeAuthenticationApisEnabled nativeAuthenticationApisEnabled Указывает, включены ли собственные API проверки подлинности, чтобы приложение пользовалось ими для обеспечения собственной проверки подлинности. Возможные значения: none, all и unknownFutureValue. Дополнительные сведения см. в статье Собственная проверка подлинности.
optionalClaims optionalClaims Разработчики приложений могут настроить необязательные утверждения в своих приложениях Microsoft Entra, чтобы указать, какие утверждения они хотят в маркерах, отправляемых в приложение службой маркеров безопасности Майкрософт. Дополнительные сведения см. в разделе Необязательные утверждения .
parentalControlSettings parentalControlSettings Указывает параметры родительского контроля для приложения.
publicClient publicClientApplication Указывает параметры для установленных клиентов, например классических или мобильных устройств.
requiredResourceAccess Коллекция requiredResourceAccess Указывает ресурсы, к которым приложению необходимо получить доступ. В этом свойстве также указывается набор делегированных разрешений и ролей приложения, необходимых для каждого из этих ресурсов. Эта настройка доступа к необходимым ресурсам определяет порядок предоставления согласия. Можно настроить не более 50 служб ресурсов (API). С середины октября 2021 г. общее количество необходимых разрешений не должно превышать 400. Значение null не допускается.
samlMetadataUrl Строка URL-адрес, по которому служба предоставляет метаданные SAML для федерации. Это свойство допустимо только для приложений с одним клиентом.
signInAudience String Указывает, какие учетные записи Майкрософт поддерживаются для текущего приложения. Поддерживаемые значения:
  • AzureADMyOrg: пользователи с рабочей или учебной учетной записью Майкрософт в клиенте Microsoft Entra моей организации (т. е. в одном клиенте).
  • AzureADMultipleOrgs: пользователи с рабочей или учебной учетной записью Майкрософт в клиенте Microsoft Entra любой организации (т. е. с несколькими клиентами).
  • AzureADandPersonalMicrosoftAccount: пользователи с личной учетной записью Майкрософт или рабочей или учебной учетной записью в клиенте Microsoft Entra любой организации.

Значение этого свойства влияет на другие свойства объекта приложения. В результате при изменении этого свойства может потребоваться сначала изменить другие свойства. Дополнительные сведения см. в разделе Различия в проверке для signInAudience.
spa spaApplication Указывает параметры для одностраничного приложения, в том числе URL-адреса выхода и URI перенаправления для кодов авторизации и маркеров доступа.
tags Коллекция String Настраиваемые строки, которые можно использовать для классификации и определения приложения. Значение null не допускается.
tokenEncryptionKeyId String Задает значение открытого ключа keyId из коллекции keyCredentials. При настройке Идентификатор Microsoft Entra шифрует все маркеры, которые он выдает, используя ключ, на который указывает это свойство. Код приложения, получающий зашифрованный маркер, должен использовать соответствующий закрытый ключ для расшифровки маркера, прежде чем его можно будет применить для пользователя, выполнившего вход.
uniqueName Строка Уникальный идентификатор, который можно назначить приложению и использовать в качестве альтернативного ключа. Может обновляться только в том случае, если null и является неизменяемым после установки.
web webApplication Указывает параметры для веб-приложения.

Отклик

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

Примеры

Пример 1. Обновление displayName для приложения

Запрос

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

PATCH https://graph.microsoft.com/v1.0/applications/{id}
Content-type: application/json

{
  "displayName": "New display name"
}

Отклик

HTTP/1.1 204 No Content

Пример 2. Обновление appRoles для приложения

В следующем примере обновляется коллекция appRoles для приложения. Чтобы сохранить все существующие роли приложения, включите их в запрос. Все существующие объекты в коллекции, которые не включены в запрос, заменяются новыми объектами. Этот объект синхронизируется с соответствующим свойством субъекта-службы в клиенте.

Запрос

PATCH https://graph.microsoft.com/v1.0/applications/fda284b5-f0ad-4763-8289-31a273fca865
Content-type: application/json

{
    "appRoles": [
        {
            "allowedMemberTypes": [
                "User",
                "Application"
            ],
            "description": "Survey.Read",
            "displayName": "Survey.Read",
            "id": "ebb7c86c-fb47-4e3f-8191-420ff1b9de4a",
            "isEnabled": false,
            "origin": "Application",
            "value": "Survey.Read"
        }
    ]
}

Отклик

HTTP/1.1 204 No Content