Atualizar x509CertificateAuthenticationMethodConfiguration

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 as propriedades do método de autenticação de certificado X.509.

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
Delegada (conta corporativa ou de estudante) Policy.ReadWrite.AuthenticationMethod Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Policy.ReadWrite.AuthenticationMethod 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. O Administrador de Política de Autenticação é a função com menos privilégios com suporte para essa operação.

Solicitação HTTP

PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/x509Certificate

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 apenas os valores das propriedades a serem atualizadas. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base nas alterações de outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

Propriedade Tipo Descrição
authenticationModeConfiguration x509CertificateAuthenticationModeConfiguration Define configurações de autenticação forte. Essa configuração inclui o modo de autenticação padrão e as diferentes regras para associações de autenticação fortes.
certificateAuthorityScopes Coleção x509CertificateAuthorityScope Define a configuração para permitir que um grupo de usuários use certificados de autoridades de certificação emissoras específicas para autenticar com êxito.
certificateUserBindings Coleção x509CertificateUserBinding Define campos no certificado X.509 que são mapeados para atributos do objeto de usuário do Microsoft Entra para vincular o certificado ao usuário. A prioridade do objeto determina a ordem em que a associação é realizada. A primeira associação correspondente será usada e o restante ignorado.
crlValidationConfiguration x509CertificateCRLValidationConfiguration Determina se a autenticação baseada em certificado deve falhar se a CA emissora não tiver uma lista de revogação de certificados válida configurada.
issuerHintsConfiguration x509CertificateIssuerHintsConfiguration Determina se as dicas de emissor (CA) são enviadas de volta ao lado do cliente para filtrar os certificados mostrados no seletor de certificados.
requireCertificateSidAlignment Booliano Quando definido como true, o Microsoft Entra ID corresponderá ao SID na extensão SID (Identificador de Segurança) ou ao valor SID do URI de SAN do certificado X.509 do usuário com o atributo SID local do usuário para usuários híbridos e SID de nuvem para usuários somente na nuvem. A autenticação baseada em certificado falhará se os valores não corresponderem. O valor não pode ser null. O valor padrão é false. Opcional.
state authenticationMethodState Os valores possíveis são: enabled, disabled.

Observação: A @odata.type propriedade com um valor de #microsoft.graph.x509CertificateAuthenticationMethodConfiguration deve ser incluída no corpo.

Resposta

Se tiver êxito, este método retornará um código de resposta 204 No Content. Ele não retorna nada no corpo da resposta.

Exemplos

Solicitação

Veja a seguir um exemplo de solicitação de atualização com as seguintes configurações:

  • Habilita o método de autenticação de certificado x509 no locatário.
  • Configura apenas uma associação de usuário entre o PrincipalName do certificado e as propriedades onPremisesUserPrincipalName do Microsoft Entra ID.
  • Define a autenticação multifator como um requisito.
  • Configura as regras de associação para o método de autenticação forte em relação ao tipo de regra.
  • Requer alinhamento SID de certificado para usuários híbridos e somente na nuvem.
PATCH https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/x509Certificate
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.x509CertificateAuthenticationMethodConfiguration",
    "id": "X509Certificate",
    "state": "enabled",
    "certificateUserBindings": [
        {
            "x509CertificateField": "PrincipalName",
            "userProperty": "onPremisesUserPrincipalName",
            "priority": 1
        }
    ],
    "authenticationModeConfiguration": {
        "x509CertificateAuthenticationDefaultMode": "x509CertificateMultiFactor",
        "rules": [
            {
                "x509CertificateRuleType": "issuerSubject",
                "identifier": "CN=ContosoCA,DC=Contoso,DC=org ",
                "x509CertificateAuthenticationMode": "x509CertificateMultiFactor"
            },
            {
                "x509CertificateRuleType": "policyOID",
                "identifier": "1.2.3.4",
                "x509CertificateAuthenticationMode": "x509CertificateMultiFactor"
            }
        ]
    },
    "issuerHintsConfiguration": {
        "state": "disabled"
    },
    "crlValidationConfiguration": {
        "state": "disabled",
        "exemptedCertificateAuthoritiesSubjectKeyIdentifiers": []
    },
    "certificateAuthorityScopes": [
        {
            "subjectKeyIdentifier": "aaaaaaaabbbbcccc111122222222222222333333",
            "publicKeyInfrastructureIdentifier": "Contoso PKI",
            "includeTargets": [
            {
                "id": "aaaaaaaa-bbbb-cccc-1111-222222222222",
                "targetType": "group"
            }
            ]
        }    
    ],
    "requireCertificateSidAlignment": true,
    "includeTargets": [
        {
            "targetType": "group",
            "id": "all_users",
            "isRegistrationRequired": false
        }
    ]
}

Resposta

HTTP/1.1 204 No Content