Compartilhar via


Atualizar customAuthenticationExtension

Namespace: microsoft.graph

Atualize as propriedades de um objeto customAuthenticationExtension . Os seguintes tipos derivados são atualmente suportados.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

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

Importante

Em cenários delegados com contas escolares ou profissionais, tem de ser atribuída ao administrador 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 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 do pedido, forneça apenas os valores das propriedades a atualizar. As propriedades existentes que não estão incluídas no corpo do pedido mantêm os valores anteriores ou são recalculadas com base em alterações a outros valores de propriedade.

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

Tem de especificar a propriedade ao @odata.type 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 esta 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 a apresentar para a extensão personalizada. Herdado de customCalloutExtension. Opcional.
endpointConfiguration customExtensionEndpointConfiguration Configuração para o ponto final da API que a extensão personalizada irá chamar. Herdado de customCalloutExtension. Opcional.

Resposta

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

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/v1.0/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