servicePrincipal: removeKey

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

Удалите учетные данные ключа из servicePrincipal. Этот метод вместе с addKey может использоваться servicePrincipal для автоматизации смены ключей с истекающим сроком действия.

Примечание.

Операции создания servicePrincipal и Update servicePrincipal могут по-прежнему использоваться для добавления и обновления учетных данных ключа для любого 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 /serviceprincipals/{id}/removeKey
POST /servicePrincipals(appId='{appId}')/removeKey

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

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

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

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

Свойство Тип Описание
keyId GUID Уникальный идентификатор пароля.
Доказательство String Самозаверяющий токен JWT, используемый в качестве доказательства владения существующими ключами. Этот токен JWT должен быть подписан закрытым ключом, соответствующим одному из существующих допустимых сертификатов, связанных с servicePrincipal. Маркер должен содержать следующие утверждения:
  • aud: аудитория должна быть 00000002-0000-0000-c000-000000000000.
  • iss: издатель должен быть идентификатором servicePrincipal , который инициирует запрос.
  • nbf: Не раньше времени.
  • exp: время окончания срока действия должно иметь значение nbf + 10 минут.

Инструкции по созданию этого маркера владения см. в разделе Создание подтверждения маркеров владения для сменных ключей.

Отклик

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

Примеры

В следующем примере показано, как вызвать этот API.

Запрос

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

POST https://graph.microsoft.com/v1.0/servicePrincipals/{id}/removeKey
Content-Type: application/json

{
    "keyId": "f0b0b335-1d71-4883-8f98-567911bfdca6",
    "proof":"eyJ0eXAiOiJ..."
}

Отклик

Ниже приводится пример отклика.

HTTP/1.1 204 No Content