Partilhar via

agentIdentityBlueprint: addKey

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.

Adicione uma credencial de chave a um agentIdentityBlueprint. Este método, juntamente com removeKey, pode ser utilizado para automatizar a implementação das chaves a expirar.

Observação

Só deve fornecer o valor da chave pública ao adicionar uma credencial de certificado à sua aplicação. Adicionar um certificado de chave privada à sua aplicação corre o risco de comprometer a aplicação.

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.

Os esquemas de identidade do agente que não têm certificados válidos existentes (ainda não foram adicionados certificados ou todos os certificados expiraram) não poderão utilizar esta ação de serviço. Em alternativa, pode utilizar a operação de esquema Identidade do agente de atualização para efetuar uma atualização.

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ão com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) AgentIdentityBlueprint.AddRemoveCreds.All AgentIdentityBlueprint.ReadWrite.All, Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application AgentIdentityBlueprint.AddRemoveCreds.All AgentIdentityBlueprint.ReadWrite.All, Directory.ReadWrite.All

Importante

Ao utilizar permissões delegadas, tem de ser atribuída ao utilizador autenticado 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.

  • Administrador de ID do Agente.
  • ID do Agente Programador – criar esquemas de identidade do agente. O principal com esta função tem a propriedade atribuída do esquema que criam e pode realizar operações de escrita nesse esquema.

Solicitação HTTP

POST /applications/{id}/microsoft.graph.agentIdentityBlueprint/addKey

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 uma representação JSON dos parâmetros. A tabela seguinte lista os parâmetros que são necessários quando chama esta ação.

Propriedade Tipo Descrição
keyCredential keyCredential A nova credencial da chave da aplicação a adicionar. O tipo, a utilização e a chave são propriedades necessárias para esta utilização. Os tipos de chave suportados são:
  • AsymmetricX509Cert: a utilização tem de ser Verify.
  • X509CertAndPassword: a utilização tem de ser Sign
passwordCredential passwordCredential Só é necessário definir secretText que deve conter a palavra-passe da chave. Esta propriedade é necessária apenas para chaves do tipo X509CertAndPassword. Defina-o para o null contrário.
prova Cadeia de caracteres Um token JWT autoassinado utilizado como prova de posse das chaves existentes. Esse token de JWT deve ser assinado usando a chave privada de um dos certificados válidos existentes do aplicativo. 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 da aplicação 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. Para obter mais informações sobre os tipos de afirmação, veja Payload de afirmações.

Resposta

Se for bem-sucedida, esta ação devolve um 200 OK código de resposta e um keyCredential no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/applications/{id}/microsoft.graph.agentIdentityBlueprint/addKey
Content-Type: application/json

{
  "keyCredential": {
    "@odata.type": "microsoft.graph.keyCredential"
  },
  "passwordCredential": {
    "@odata.type": "microsoft.graph.passwordCredential"
  },
  "proof": "String"
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": {
    "@odata.type": "microsoft.graph.keyCredential"
  }
}
  • Last updated on