Atualizar customAuthenticationExtension

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 de um objeto customAuthenticationExtension . Os tipos derivados a seguir têm suporte no momento.

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) CustomAuthenticationExtension.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application CustomAuthenticationExtension.ReadWrite.All Indisponível.

Importante

Para acesso delegado usando contas corporativas ou de estudante, o administrador 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 Extensibilidade de Autenticação
  • Administrador de Aplicativos

Solicitação HTTP

PATCH /identity/customAuthenticationExtensions/{customAuthenticationExtensionId}

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.

Você deve especificar a @odata.type propriedade ao atualizar um objeto customAuthenticationExtension . Por exemplo, para atualizar um tipo de objeto onTokenIssuanceStartCustomExtension , defina a @odata.type propriedade como #microsoft.graph.onTokenIssuanceStartCustomExtension.

Propriedade Tipo Descrição
authenticationConfiguration customExtensionAuthenticationConfiguration A configuração de autenticação para essa extensão personalizada. Herdado de customCalloutExtension. Opcional.
description Cadeia de caracteres Descrição da extensão personalizada. Herdado de customCalloutExtension. Opcional.
displayName Cadeia de caracteres Nome de exibição para a extensão personalizada. Herdado de customCalloutExtension. Opcional.
handler onAttributeCollectionStartCustomExtensionHandler O manipulador a ser invocado quando as condições forem atendidas. Pode ser atualizado para o tipo de ouvinte onAttributeCollectionStartCustomExtensionListener .
handler onAttributeCollectionSubmitCustomExtensionHandler O manipulador a ser invocado quando as condições forem atendidas. Pode ser atualizado para o tipo de ouvinte onAttributeCollectionSubmitCustomExtensionListener .
handler onOtpSendCustomExtensionHandler O manipulador a ser invocado quando as condições forem atendidas. Pode ser atualizado para o tipo de ouvinte onOtpSendCustomExtensionListener .
handler onTokenIssuanceStartCustomExtensionHandler O manipulador a ser invocado quando as condições forem atendidas. Pode ser atualizado para o tipo de ouvinte onTokenIssuanceStartCustomExtensionListener .
endpointconfiguration customExtensionEndpointConfiguration Configuração para o ponto de extremidade da API que a extensão personalizada chamará. Herdado de customCalloutExtension. Opcional.
behaviorOnError customExtensionBehaviorOnError Vamos configurar o comportamento se a chamada para a extensão de autenticação personalizada retornar um erro. Opcional.

Resposta

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

Exemplos

Exemplo 1: Atualizar um objeto onTokenIssuanceStartCustomExtension

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH hhttps://graph.microsoft.com/beta/identity/customAuthenticationExtensions/6fc5012e-7665-43d6-9708-4370863f4e6e
Content-Type: application/json
Content-length: 468

{
    "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension",
    "displayName": "onTokenIssuanceStartCustomExtension",
    "description": "Fetch additional claims from custom user store",
    "endpointConfiguration": {
        "@odata.type": "#microsoft.graph.httpRequestEndpoint",
        "targetUrl": "https://authenticationeventsAPI.contoso.com"
    },
    "authenticationConfiguration": {
        "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
        "resourceId": "api://authenticationeventsAPI.contoso.com/a13d0fc1-04ab-4ede-b215-63de0174cbb4"
    },
    "claimsForTokenConfiguration": [
        {
            "claimIdInApiResponse": "DateOfBirth"
        },
        {
            "claimIdInApiResponse": "CustomRoles"
        }
    ]
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content

Exemplo 2: Atualizar um objeto onVerifiedIdClaimValidationCustomExtension

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/beta/identity/customAuthenticationExtensions/6a0a3429-be77-0aed-951e-1c8aed62bf8a
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.onVerifiedIdClaimValidationCustomExtension",
    "displayName": "Verified ID Claim Validation (updated)",
    "description": "Updated description for Verified ID claim validation"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content