application: removeKey
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Удаление учетных данных ключа из приложения. Этот метод вместе с addKey может использоваться приложением для автоматизации смены ключей с истекающим сроком действия.
Примечание.
Операции создания servicePrincipal и Update servicePrincipal могут по-прежнему использоваться для добавления и обновления учетных данных ключа для любого приложения с приложением или контекстом пользователя.
В рамках проверки запроса для этого метода перед выполнением действия проверяется подтверждение владения существующим ключом.
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | Application.ReadWrite.All | Directory.ReadWrite.All |
Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
Приложение | Application.ReadWrite.OwnedBy | Application.ReadWrite.All, Directory.ReadWrite.All |
Примечание.
Приложению не требуется определенное разрешение на свертывку собственных ключей.
HTTP-запрос
Вы можете обратиться к приложению, используя его идентификатор или appId. Id и appId называются идентификатором объекта и идентификатором приложения (клиента) соответственно в регистрациях приложений в Центр администрирования Microsoft Entra.
POST /applications/{id}/removeKey
POST /applications(appId='{appId}')/removeKey
Заголовки запросов
Имя | Описание |
---|---|
Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Content-Type | application/json. Обязательно. |
Текст запроса
В тексте запроса укажите следующие обязательные свойства.
Свойство | Тип | Описание |
---|---|---|
keyId | GUID | Уникальный идентификатор пароля. |
Доказательство | String | Самозаверяющий токен JWT, используемый в качестве доказательства владения существующими ключами. Маркер JWT должен быть подписан с использованием закрытого ключа одного из существующих действительных сертификатов приложения. Маркер должен содержать следующие утверждения:
Инструкции по созданию этого маркера владения см. в разделе Создание подтверждения маркеров владения для сменных ключей. |
Отклик
В случае успешного выполнения этот метод возвращает код отклика 204 No content
.
Примеры
В следующем примере показано, как вызвать этот API.
Запрос
Ниже показан пример запроса.
POST https://graph.microsoft.com/beta/applications/{id}/removeKey
Content-Type: application/json
{
"keyId": "f0b0b335-1d71-4883-8f98-567911bfdca6",
"proof":"eyJ0eXAiOiJ..."
}
Отклик
Ниже приводится пример отклика.
HTTP/1.1 204 No Content