Atualizar mutualTlsOauthConfiguration

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.

Atualize o recurso mutualTlsOauthConfiguration especificado.

Você só pode atualizar as duas seguintes propriedades: displayName, certificateAuthority.

Para atualizar um subconjunto de objetos na coleção certificateAuthorities , primeiro obtenha a lista completa, faça suas modificações e, em seguida, reposte todo o conteúdo da lista de atributos certificateAuthorities no corpo da solicitação. A exclusão de um subconjunto de objetos os remove da coleção.

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

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ❌ ❌ ❌

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos 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 com privilégios mais elevados
Delegado (conta corporativa ou de estudante) MutualTlsOauthConfiguration.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application MutualTlsOauthConfiguration.ReadWrite.All Indisponível.

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. Esta operação dá suporte às seguintes funções internas, que fornecem apenas o menor privilégio necessário:

  • Administrador de Dispositivo de Nuvem
  • Administrador de Dispositivo IoT

Solicitação HTTP

PATCH /directory/certificateAuthorities/mutualTlsOauthConfigurations/{mutualTlsOauthConfigurationId}

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 uma representação JSON do objeto mutualTlsOauthConfiguration .

Você pode especificar as propriedades a seguir ao atualizar um mutualTlsOauthConfiguration.

Propriedade Tipo Descrição
certificateAuthority coleção certificateAuthority Propriedade de vários valores que representa uma lista de autoridades de certificação confiáveis.
displayName Cadeia de caracteres Nome amigável.

Resposta

Se for bem-sucedido, esse método retornará um código de 200 OK resposta e um objeto mutualTlsOauthConfiguration no corpo da resposta. Se ocorrer uma falha de validação durante as etapas de validação do certificado, o método retornará um junto com a mensagem de 400 Bad Request erro, Invalid value specified for property 'certificate' of resource 'CertificateAuthorityInformation'. Para obter mais informações, consulte Tipos de recursos e respostas de erro do Microsoft Graph.

Exemplos

Exemplo 1: Atualizar o nome de exibição

O exemplo a seguir mostra como atualizar o nome de exibição de um objeto mutualTlsOauthConfiguration para DoorCamera_Model_X_TrustedCAsTHIS_IS_A_NEW_NAME.

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/beta/directory/certificateAuthorities/mutualTlsOauthConfigurations/eec5ba11-2fc0-4113-83a2-ed986ed13cdb
Content-Type: application/json

{
  "displayName": "THIS_IS_A_NEW_NAME"
}

Resposta

O exemplo a seguir mostra a resposta.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/certificateAuthorities/mutualTlsOauthConfigurations/$entity",
  "id":"eec5ba11-2fc0-4113-83a2-ed986ed13cdb",
  "displayName": "THIS_IS_A_NEW_NAME",
  "tlsClientAuthParameter": "tls_client_auth_subject_dn",
  "certificateAuthorities": [
    {
      "@odata.type": "microsoft.graph.certificateAuthority"
    }
  ]
}

Exemplo 2: Remover um certificado da lista de certificateAuthorities

Este exemplo pressupõe que o objeto original armazenado tem o valor a seguir. Observe que o recurso inicial contém dois valores na lista de autoridade de certificação.

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/certificateAuthorities/mutualTlsOauthConfigurations/$entity",
  "id": "eec5ba11-2fc0-4113-83a2-ed986ed13cdb",
  "displayName": "DoorCamera_Model_X_TrustedCAs",
  "tlsClientAuthParameter": "tls_client_auth_subject_dn",
  "certificateAuthorities": [
    {
      "isRootAuthority": true,
      "certificateRevocationListUrl": "http://LakeshoreRetail.com/root.crl",
      "deltaCertificateRevocationListUrl": null,
      "certificate": "joGrWL+Yqkik/CABWG0d1w....",
      "issuer": "Lakeshore Retail",
      "issuerSubjectkeyIdentifier": "SKI"
    },
    {
      "isRootAuthority": true,
      "certificateRevocationListUrl": "http://LakeshoreRetail.com/root.crl",
      "deltaCertificateRevocationListUrl": null,
      "certificate": "koGrWL+Yqkik/CABWG0d1w....",
      "issuer": "Lakeshore Retail",
      "issuerSubjectkeyIdentifier": "SKI"
    }
  ]
}

Solicitação

O exemplo a seguir mostra uma solicitação que atualiza a lista de autoridades de certificação para conter apenas um único certificado, o que remove o outro.

PATCH https://graph.microsoft.com/beta/directory/certificateAuthorities/mutualTlsOauthConfigurations/00001111-aaaa-2222-bbbb-3333cccc4444
Content-Type: application/json

{
  "certificateAuthorities": [
    {
      "isRootAuthority": true,
      "certificateRevocationListUrl": "http://LakeshoreRetail.com/root.crl",
      "deltaCertificateRevocationListUrl": null,
      "certificate": "Binary",
      "issuer": "Lakeshore Retail",
      "issuerSubjectkeyIdentifier": "SKI"
    }
  ]
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 200 OK
Location: "https://graph.microsoft.com/beta/directory/certificateAuthorities/mutualTlsOauthConfigurations/00001111-aaaa-2222-bbbb-3333cccc4444"

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/certificateAuthorities/mutualTlsOauthConfigurations/$entity",
  "id":"eec5ba11-2fc0-4113-83a2-ed986ed13cdb",
  "displayName": "DoorCamera_Model_X_TrustedCAs",
  "tlsClientAuthParameter": "tls_client_auth_subject_dn",
  "certificateAuthorities": [
    {
      "isRootAuthority": true,
      "certificateRevocationListUrl": "http://LakeshoreRetail.com/root.crl",
      "deltaCertificateRevocationListUrl": null,
      "certificate": "Binary",
      "issuer": "Lakeshore Retail",
      "issuerSubjectkeyIdentifier": "SKI"
    }
  ]
}