Обновление приложения
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Обновление свойств объекта приложения .
Важно!
Использование метода 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, которое ожидает приложение. Чтобы задать этот атрибут, используйте одно из следующих допустимых строковых значений.
|
identifierUris | Коллекция String | URI, которые идентифицируют приложение в клиенте Microsoft Entra или в проверенном пользовательском домене, если приложение является мультитенантным. Дополнительные сведения см. в разделе Объекты приложения и субъекта-службы. Для выражений фильтра в случае многозначных свойств требуется оператор any. Значение null не допускается. |
info | informationalUrl | Основные сведения о профиле приложения, такие как маркетинг приложения, поддержка, условия обслуживания и URL-адреса заявлений о конфиденциальности. Условия обслуживания и заявление о конфиденциальности отображаются в окне запроса согласия пользователя. Дополнительные сведения см. в разделе Добавление условий обслуживания и заявление о конфиденциальности для зарегистрированных приложений Microsoft Entra. |
isFallbackPublicClient | Boolean | Указывает резервный тип приложения как общедоступный клиент, например установленное приложение, запущенное на мобильном устройстве. Значение по умолчанию — false , что означает, что резервный тип приложения является конфиденциальным клиентом, например веб-приложением. Существуют определенные сценарии, в которых Microsoft Entra ID не могут определить тип клиентского приложения (например, поток ROPC, в котором он настроен без указания URI перенаправления). В таких случаях Microsoft Entra ID интерпретирует тип приложения на основе значения этого свойства. |
keyCredentials | Коллекция keyCredential | Коллекция ключевых учетных данных, связанных с приложением. Значение null не допускается. |
logo | Stream | Основной логотип для приложения. Значение null не допускается. Используйте метод PUT для обновления логотипа. |
onPremisesPublishing | onPremisesPublishing | Представляет набор свойств для настройки Microsoft Entra прокси приложения для локального приложения. Это свойство можно задать только после создания приложения и не может быть обновлено в том же запросе, что и другие свойства приложения. |
optionalClaims | optionalClaims | Разработчики приложений могут настроить необязательные утверждения в своих приложениях Microsoft Entra, чтобы указать, какие утверждения они хотят в маркерах, отправляемых в приложение службой маркеров безопасности Майкрософт. Дополнительные сведения см. в разделе Необязательные утверждения . |
parentalControlSettings | parentalControlSettings | Указывает параметры родительского контроля для приложения. |
publicClient | publicClientApplication | Указывает параметры для установленных клиентов, например классических или мобильных устройств. |
requiredResourceAccess | Коллекция requiredResourceAccess | Указывает ресурсы, к которым приложению необходимо получить доступ. В этом свойстве также указывается набор делегированных разрешений и ролей приложения, необходимых для каждого из этих ресурсов. Эта настройка доступа к необходимым ресурсам определяет порядок предоставления согласия. Можно настроить не более 50 служб ресурсов (API). С середины октября 2021 г. общее количество необходимых разрешений не должно превышать 400. Значение null не допускается. |
samlMetadataUrl | Строка | URL-адрес, по которому служба предоставляет метаданные SAML для федерации. Это свойство допустимо только для приложений с одним клиентом. |
signInAudience | String | Указывает, какие учетные записи Майкрософт поддерживаются для текущего приложения. Поддерживаемые значения:
Значение этого свойства влияет на другие свойства объекта приложения. В результате при изменении этого свойства может потребоваться сначала изменить другие свойства. Дополнительные сведения см. в разделе Различия в проверке для signInAudience. |
spa | spaApplication | Указывает параметры для одностраничного приложения, в том числе URL-адреса выхода и URI перенаправления для кодов авторизации и маркеров доступа. |
tags | Коллекция String | Настраиваемые строки, которые можно использовать для классификации и определения приложения. Значение null не допускается. |
tokenEncryptionKeyId | String | Задает значение открытого ключа keyId из коллекции keyCredentials. После настройки Microsoft Entra ID шифрует все выдаваемые маркеры с помощью ключа, на который указывает это свойство. Код приложения, получающий зашифрованный маркер, должен использовать соответствующий закрытый ключ для расшифровки маркера, прежде чем его можно будет применить для пользователя, выполнившего вход. |
uniqueName | Строка | Уникальный идентификатор, который можно назначить приложению в качестве альтернативного идентификатора. Неизменяемый. Только для чтения. |
web | webApplication | Указывает параметры для веб-приложения. |
spa | spaApplication | Указывает параметры для одностраничного приложения, в том числе URL-адреса выхода и URI перенаправления для кодов авторизации и маркеров доступа. |
windows | windowsApplication | Указывает параметры приложений для устройств под управлением Microsoft Windows, опубликованных в Microsoft Store или магазине игр Xbox. Включает идентификаторы безопасности пакета и URI перенаправления для кодов авторизации и маркеров доступа. |
Отклик
В случае успешного выполнения этот метод возвращает код отклика 204 No Content
и не возвращает ничего в теле отклика.
Примеры
Пример 1. Обновление displayName для приложения
Запрос
Пример показан в следующем запросе.
PATCH https://graph.microsoft.com/beta/applications/{id}
Content-type: application/json
{
"displayName": "New display name"
}
Отклик
HTTP/1.1 204 No Content
Пример 2. Обновление appRoles для приложения
В следующем примере обновляется коллекция appRoles для приложения. Чтобы сохранить все существующие роли приложения, включите их в запрос. Все существующие объекты в коллекции, которые не включены в запрос, заменяются новыми объектами. Этот объект синхронизируется с соответствующим свойством субъекта-службы в клиенте.
Запрос
PATCH https://graph.microsoft.com/beta/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
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по