Condividi tramite


Risolvere i problemi relativi all'estensione di autenticazione personalizzata

Gli eventi di autenticazione e i provider di attestazioni personalizzati consentono di personalizzare l'esperienza di autenticazione di Microsoft Entra integrando con sistemi esterni. Ad esempio, è possibile creare un provider di attestazioni personalizzato sotto forma di API e configurare un'app OpenID Connect per ricevere token con attestazioni da un archivio esterno.

Error behavior

Quando una chiamata API ha esito negativo, il comportamento di errore è il seguente:

  • Per le app OpenId Connect, Microsoft Entra ID reindirizza l'utente all'applicazione client con un messaggio di errore. Un token non viene coniato.
  • Per le app SAML - Microsoft Entra ID mostra all'utente una schermata di errore nell'esperienza di autenticazione. L'utente non viene reindirizzato all'applicazione client.

Il codice di errore restituito all'applicazione o l'utente è generico. To troubleshoot, check the sign-in logs for the error codes.

Logging

Per risolvere i problemi relativi all'endpoint API REST del provider di rivendicazioni personalizzato, l'API REST deve gestire il logging. Funzioni di Azure e altre piattaforme di sviluppo api offrono soluzioni di registrazione approfondite. Usare queste soluzioni per ottenere informazioni dettagliate sul comportamento delle API e risolvere i problemi relativi alla logica dell'API.

Log di accesso di Microsoft Entra

È anche possibile usare i log di accesso di Microsoft Entra oltre ai log dell'API REST e alle soluzioni di diagnostica dell'ambiente di hosting. Usando i log di accesso di Microsoft Entra, è possibile trovare errori che possono influire sugli accessi degli utenti. I log di accesso di Microsoft Entra forniscono informazioni sullo stato HTTP, sul codice di errore, sulla durata dell'esecuzione e sul numero di tentativi che si sono verificati l'API è stata chiamata da Microsoft Entra ID.

Microsoft Entra sign-in logs also integrate with Azure Monitor. È possibile configurare avvisi e monitoraggio, visualizzare i dati e integrarli con gli strumenti siem (Security Information and Event Management). Ad esempio, è possibile configurare le notifiche se il numero di errori supera una determinata soglia scelta.

Per accedere ai log di accesso di Microsoft Entra:

  1. Accedere all'interfaccia di amministrazione di Microsoft Entra come almeno un amministratore di applicazioni cloud.

  2. Browse to Entra ID>Enterprise apps.

  3. Select Sign-in logs, and then select the latest sign-in log.

  4. For more details, select the Authentication Events tab. Information related to the custom authentication extension REST API call is displayed, including any error codes.

    Screenshot che mostra le informazioni sugli eventi di autenticazione.

Informazioni di riferimento su codici di errore

Usare la tabella seguente per diagnosticare un codice di errore.

Error code Error name Description
1003000 EventHandlerUnexpectedError Si è verificato un errore imprevisto durante l'elaborazione di un gestore eventi.
1003001 CustomExtensionUnexpectedError Si è verificato un errore imprevisto durante la chiamata di un'API di estensione personalizzata.
1003002 CustomExtensionInvalidHTTPStatus L'API di estensione personalizzata ha restituito un codice di stato HTTP non valido. Verificare che l'API restituisca un codice di stato accettato definito per il tipo di estensione personalizzato.
1003003 CustomExtensionInvalidResponseBody Si è verificato un problema durante l'analisi del corpo della risposta dell'estensione personalizzata. Verificare che il corpo della risposta dell'API sia in uno schema accettabile per il tipo di estensione personalizzato.
1003004 CustomExtensionThrottlingError Sono presenti troppe richieste di estensione personalizzate. Questa eccezione viene generata per le chiamate API di estensione personalizzate quando vengono raggiunti i limiti di limitazione.
1003005 CustomExtensionTimedOut L'estensione personalizzata non ha risposto entro il timeout consentito. Verificare che l'API risponda entro il timeout configurato per l'estensione personalizzata. Può anche indicare che il token di accesso non è valido. Seguire la procedura per chiamare direttamente l'API REST.
1003006 CustomExtensionInvalidResponseContentType Il tipo di contenuto della risposta dell'estensione personalizzata non è 'application/json'.
1003007 CustomExtensionNullClaimsResponse L'API di estensione personalizzata ha risposto con un contenitore di attestazioni null.
1003008 CustomExtensionInvalidResponseApiSchemaVersion L'API di estensione personalizzata non ha risposto con la stessa versione di apiSchema per la quale è stata chiamata.
1003009 CustomExtensionEmptyResponse Il corpo della risposta dell'API dell'estensione personalizzata era null quando ciò non era previsto.
1003010 CustomExtensionInvalidNumberOfActions La risposta dell'API di estensione personalizzata includeva un numero diverso di azioni rispetto a quelle supportate per il tipo di estensione personalizzato.
1003011 CustomExtensionNotFound Impossibile trovare l'estensione personalizzata associata a un listener di eventi.
1003012 CustomExtensionInvalidActionType L'estensione personalizzata ha restituito un tipo di azione non valido definito per il tipo di estensione personalizzato.
1003014 CustomExtensionIncorrectResourceIdFormat The identifierUris property in the manifest for the application registration for the custom extension, should be in the format of "api://{fully qualified ___domain name}/{appid}.
1003015 CustomExtensionDomainNameDoesNotMatch TargetUrl e resourceId dell'estensione personalizzata devono avere lo stesso nome di dominio completo.
1003016 CustomExtensionResourceServicePrincipalNotFound L'id app dell'estensione personalizzata resourceId deve corrispondere a un'entità servizio reale nel tenant.
1003017 CustomExtensionClientServicePrincipalNotFound Il principal del servizio della risorsa di estensione personalizzata non è stato trovato nel tenant.
1003018 CustomExtensionClientServiceDisabled Il principale del servizio di risorsa di estensione personalizzata è disabilitato in questo tenant.
1003019 CustomExtensionResourceServicePrincipalDisabled Il principale del servizio di risorsa di estensione personalizzata è disabilitato in questo tenant.
1003020 CustomExtensionIncorrectTargetUrlFormat L'URL di destinazione è in un formato non corretto. Deve essere un URL valido che inizia con https.
1003021 CustomExtensionPermissionNotGrantedToServicePrincipal L'entità principale del servizio non ha il consenso dell'amministratore per il ruolo dell'applicazione CustomAuthenticationExtensions.Receive.Payload, noto anche come autorizzazione dell'applicazione, che è necessaria affinché l'app possa ricevere richieste HTTP dell'estensione di autenticazione personalizzata.
1003022 CustomExtensionMsGraphServicePrincipalDisabledOrNotFound L'entità servizio MS Graph è disabilitata o non si trova in questo tenant.
1003023 CustomExtensionBlocked L'endpoint usato per l'estensione personalizzata è bloccato dal servizio.
1003024 CustomExtensionResponseSizeExceeded La dimensione della risposta dell'estensione personalizzata ha superato il limite massimo.
1003025 CustomExtensionResponseClaimsSizeExceeded La dimensione totale delle attestazioni nella risposta dell'estensione personalizzata ha superato il limite massimo.
1003026 CustomExtensionNullOrEmptyClaimKeyNotSupported L'API di estensione personalizzata ha risposto con attestazioni contenenti una chiave null o vuota'
1003027 CustomExtensionConnectionError Errore durante la connessione all'API di estensione personalizzata.

Chiamare direttamente l'API REST

L'API REST è protetta da un token di accesso Microsoft Entra. È possibile testare l'API tramite;

  • Obtaining an access token with an application registration associated with the custom authentication extensions
  • Testare l'API in locale usando uno strumento di test api.
  1. For local development and testing purposes, open local.settings.json and replace the code with the following JSON:

    {
      "IsEncrypted": false,
      "Values": {
        "AzureWebJobsStorage": "",
        "AzureWebJobsSecretStorageType": "files",
        "FUNCTIONS_WORKER_RUNTIME": "dotnet",
        "AuthenticationEvents__BypassTokenValidation" : false
      }
    }
    

    Note

    If you used the Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents NuGet package, be sure to set "AuthenticationEvents__BypassTokenValidation" : true for local testing purposes.

  2. Using your preferred API testing tool, create a new HTTP request and set the HTTP method to POST.

  3. Usare il corpo JSON seguente che imita la richiesta inviata da Microsoft Entra ID all'API REST.

    {
        "type": "microsoft.graph.authenticationEvent.tokenIssuanceStart",
        "source": "/tenants/aaaabbbb-0000-cccc-1111-dddd2222eeee/applications/00001111-aaaa-2222-bbbb-3333cccc4444",
        "data": {
            "@odata.type": "microsoft.graph.onTokenIssuanceStartCalloutData",
            "tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
            "authenticationEventListenerId": "11112222-bbbb-3333-cccc-4444dddd5555",
            "customAuthenticationExtensionId": "22223333-cccc-4444-dddd-5555eeee6666",
            "authenticationContext": {
                "correlationId": "aaaa0000-bb11-2222-33cc-444444dddddd",
                "client": {
                    "ip": "127.0.0.1",
                    "locale": "en-us",
                    "market": "en-us"
                },
                "protocol": "OAUTH2.0",
                "clientServicePrincipal": {
                    "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
                    "appId": "00001111-aaaa-2222-bbbb-3333cccc4444",
                    "appDisplayName": "My Test application",
                    "displayName": "My Test application"
                },
                "resourceServicePrincipal": {
                    "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
                    "appId": "00001111-aaaa-2222-bbbb-3333cccc4444",
                    "appDisplayName": "My Test application",
                    "displayName": "My Test application"
                },
                "user": {
                    "companyName": "Casey Jensen",
                    "createdDateTime": "2023-08-16T00:00:00Z",
                    "displayName": "Casey Jensen",
                    "givenName": "Casey",
                    "id": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
                    "mail": "casey@contoso.com",
                    "onPremisesSamAccountName": "Casey Jensen",
                    "onPremisesSecurityIdentifier": "<Enter Security Identifier>",
                    "onPremisesUserPrincipalName": "Casey Jensen",
                    "preferredLanguage": "en-us",
                    "surname": "Jensen",
                    "userPrincipalName": "casey@contoso.com",
                    "userType": "Member"
                }
            }
        }
    }
    

    Tip

    If you're using an access token obtained from Microsoft Entra ID, select Authorization and then select Bearer token, then paste the access token you received from Microsoft Entra ID.

  4. Select Send, and you should receive a JSON response similar to the following:

    {
        "data": {
            "@odata.type": "microsoft.graph.onTokenIssuanceStartResponseData",
            "actions": [
                {
                    "@odata.type": "microsoft.graph.tokenIssuanceStart.provideClaimsForToken",
                    "claims": {
                        "customClaim1": "customClaimValue1",
                        "customClaim2": [
                            "customClaimString1",
                            "customClaimString2" 
                        ]
                    }
                }
    
            ]
        }
    }
    

Miglioramenti comuni delle prestazioni

Uno dei problemi più comuni è che l'API del provider di dichiarazioni personalizzate non risponde entro il timeout di due secondi. Se l'API REST non risponde nei tentativi successivi, l'autenticazione non riesce. Per migliorare le prestazioni dell'API REST, seguire i suggerimenti seguenti:

  1. Se l'API accede a qualsiasi API downstream, memorizzare nella cache il token di accesso usato per chiamare queste API, quindi non è necessario acquisire un nuovo token in ogni esecuzione.
  2. I problemi di prestazioni sono spesso correlati ai servizi downstream. Aggiungere il logging, che registra il tempo del processo per chiamare qualsiasi servizio a valle.
  3. Se si usa un provider di servizi cloud per ospitare l'API, usare un piano di hosting che mantiene sempre "caldo" l'API. Per Funzioni di Azure, può essere il piano Premium o il piano dedicato.
  4. Eseguire test di integrazione automatizzati per le autenticazioni. È anche possibile usare gli strumenti di test api per testare solo le prestazioni dell'API.

See also