servicePrincipal: removeKey

Namespace: microsoft.graph

Remova uma credencial de chave de um servicePrincipal. Esse método junto com addKey pode ser usado por um servicePrincipal para automatizar a rolagem de suas chaves expirando.

Observação

Criar serviçosPrincipal e Atualizar Operaçõesprincipal podem continuar a ser usadas para adicionar e atualizar credenciais de chave para qualquer serviçoPrincipal com ou sem o contexto de um usuário.

Como parte da validação da solicitação para esse método, uma prova de posse de uma chave existente é verificada antes que a ação possa ser executada.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global Governo dos EUA L4 GOVERNO DOS EUA L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante) Application.ReadWrite.All Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Application.ReadWrite.OwnedBy Application.ReadWrite.All, Directory.ReadWrite.All

Solicitação HTTP

Você pode abordar a entidade de serviço usando sua id ou appId. Id e appId são chamados de ID de Objeto e ID do Aplicativo (Cliente), respectivamente, em registros de aplicativo no centro de administração do Microsoft Entra.

POST /serviceprincipals/{id}/removeKey
POST /servicePrincipals(appId='{appId}')/removeKey

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça as seguintes propriedades necessárias.

Propriedade Tipo Descrição
keyId Guid O identificador exclusivo para a senha.
Prova Cadeia de caracteres Um token JWT autoassinado usado como prova de posse das chaves existentes. Esse token JWT deve ser assinado com uma chave privada que corresponda a um dos certificados válidos existentes associados ao serviçoPrincipal. O token deve conter os seguintes argumentos:
  • aud: O público precisa ser 00000002-0000-0000-c000-000000000000.
  • iss: o emissor precisa ser a ID do servicePrincipal que inicia a solicitação.
  • nbf: não antes do tempo.
  • exp: o tempo de expiração deve ser o valor de nbf + 10 minutos.

Para obter etapas para gerar essa prova de token de posse, consulte Gerando a prova de tokens de posse para chaves de rolamento.

Resposta

Se tiver êxito, este método retornará um código de resposta 204 No content.

Exemplos

O exemplo a seguir mostra como chamar essa API.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content