Compartilhar via

servicePrincipal: removeKey

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Remova uma credencial de chave de um servicePrincipal. Este método, juntamente com addKey , pode ser utilizado por um servicePrincipal para automatizar a implementação das chaves a expirar.

Observação

As operações servicePrincipal e Update servicePrincipal podem continuar a ser utilizadas para adicionar e atualizar credenciais de chave para qualquer servicePrincipal com ou sem o contexto de um utilizador.

Como parte da validação do pedido para este método, é verificada uma prova de posse de uma chave existente antes de a ação poder ser executada.

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
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

Importante

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.

  • Um utilizador membro não administrador com permissões de utilizador predefinidas – para aplicações que possui
  • Programador de Aplicações – para aplicações que possuem
  • Administrador de Aplicativos de Nuvem
  • Administrador de Aplicativos

Solicitação HTTP

Pode abordar o principal de serviço com o respetivo ID ou appId. O id e o appId são referidos como o ID do Objeto e o ID da Aplicação (Cliente), respetivamente, nos registos de aplicações 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 do pedido, forneça as seguintes propriedades necessárias.

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

Para obter os passos para gerar este token de prova de posse, veja Gerar tokens de prova de posse para chaves sem interrupção.

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/beta/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
  • Last updated on