Migrieren Sie Ihre ArcGIS -Karten SDK für .NET -Anwendungen auf das neue Authentifizierungssystem

Im Jahr 2024 führte das ARCGIS-Karten SDK für .NET-Team im Rahmen einer langfristigen Bemühungen zur Vereinfachung signifikante Änderungen der Authentifizierungs-APIs ein

In 2024, the ArcGIS Maps SDK for .NET team introduced significant changes to authentication APIs as part of a long-term effort to simplify and align the .NET Maps SDK with other Native Maps SDKs. This transition also involved deprecating older APIs to streamline development and maintain compatibility with the broader ArcGIS Platform.

Im Jahr 2024 führte das ArcGIS-Karten SDK für .NET-Team im Rahmen einer langfristigen Anstrengung, die .NET-Karten-SDK-SDK-SDKs zu vereinfachen und auszurichten, signifikante Änderungen der Authentifizierungs-APIs vor. Dieser Übergang beinhaltete auch die Abschaffung älterer APIs, um die Entwicklung zu rationalisieren und die Kompatibilität mit der breiteren ArcGIS -Plattform aufrechtzuerhalten.

This blog post will guide you through this transition, highlighting new capabilities, outlining clear paths from deprecated APIs, and providing practical code examples to help you implement these changes quickly and confidently.

Dieser Blog -Beitrag führt Sie durch diesen Übergang, zeigt neue Funktionen hervor, um klare Pfade von veralteten APIs umzusetzen und praktische Codebeispiele bereitzustellen, damit Sie diese Änderungen schnell und sicher umsetzen können.

New Credential Types

Neue Anmeldeinformationen

Let’s start by exploring the new credential types that form the foundation of the updated authentication system.

Beginnen wir mit den neuen Anmeldeinformationen, die die Grundlage des aktualisierten Authentifizierungssystems bilden.

OAuthUserCredential (200.6+)

OauthuSercredential (200,6+)

This replaces OAuthTokenCredentials of type OAuthAuthorizationCode.

Dies ersetzt OaututhtokenCredentials des Typs OAuthauthorizationCode.

OAuthUserCredential implements user authentication using OAuth “authorization code” flow with PKCE. This is the recommended approach for authenticating end users, providing extra security compared to other methods.

OAuthUSercredential implementiert die Benutzerauthentifizierung mit OAuth "Autorisierungscode" mit PKCE. Dies ist der empfohlene Ansatz für die Authentifizierung von Endbenutzern und bietet zusätzliche Sicherheit im Vergleich zu anderen Methoden.

When a user signs in to your application with their ArcGIS account, a token is generated that authorizes your app to access services and content on behalf of the user. The available resources and functionality depend on the user’s ArcGIS account type, roles, and privileges.

Wenn sich ein Benutzer mit seinem ARCGIS -Konto bei Ihrer Anwendung anmeldet, wird ein Token generiert, der Ihre App zum Zugriff auf Dienste und Inhalte im Namen des Benutzers ermächtigt. Die verfügbaren Ressourcen und Funktionen hängen vom ArcGIS -Konto, Rollen und Berechtigungen des Benutzers ab.

To implement this authentication flow, you need to:

Um diesen Authentifizierungsfluss zu implementieren, müssen Sie:

Our Access services with OAuth credentials tutorial provides a complete implementation example.

Unsere Zugriffsdienste mit OAuth -Anmeldeinformationen bieten ein vollständiges Implementierungsbeispiel.

OAuthAppCredential (200.5+)

OAuthAppcredential (200,5+)

This replaces OAuthTokenCredentials of type OAuthClientCredentials.

Dies ersetzt OaututhtokenCredentials von Typ OAuthClientcredentials.

OAuthApplicationCredential implements app authentication using OAuth “client credentials” flow. Use this to create applications that do not require users to sign in, but still need access to token-secured resources and services.

OAuthApplicationCredential implementiert die App -Authentifizierung unter Verwendung von OAuth -Client -Anmeldeinformationen. Verwenden Sie dies, um Anwendungen zu erstellen, bei denen Benutzer nicht anmelden müssen, aber dennoch Zugriff auf Ressourcen und Dienste mit Token erfordern.

With this approach, requests are made using the credits and privileges associated with your app’s account rather than an individual user’s account. An app credential is created from a client ID and client secret that have been pre-registered with the portal.

Mit diesem Ansatz werden Anfragen mithilfe der mit dem Konto Ihrer App verbundenen Credits und Berechtigungen und nicht mit dem Konto eines einzelnen Benutzers gestellt. Eine App-Anmeldeinformation wird aus einer Client-ID und einem Client-Geheimnis erstellt, die mit dem Portal vorberechtigt wurden.

The client secret should be treated as confidential information since it allows direct billing to your developer account. This authentication method is intended for secure environments where credentials cannot be easily exposed to end users. Never include your client secret in publicly distributed applications.

Das Kundegeheimnis sollte als vertrauliche Informationen behandelt werden, da es eine direkte Abrechnung Ihres Entwicklerkontos ermöglicht. Diese Authentifizierungsmethode ist für sichere Umgebungen vorgesehen, in denen Anmeldeinformationen nicht leicht Endbenutzern ausgesetzt werden können. Fügen Sie Ihr Kundengeheimnis niemals in öffentlich verteilte Anwendungen ein.

AccessTokenCredential (200.6+)

AccessTokenCredential (200,6+)

This replaces ArcGISTokenCredentials created by GenerateCredentialAsync.

Dies ersetzt ArcgistokenCredentials, die von GenerateCredentialAsync erstellt wurden.

AccessTokenCredential provides an access token for secured ArcGIS content and services. You can obtain this token in several ways:

AccessTokenCredential bietet ein Zugriffstoken für gesicherte ArcGIS -Inhalte und -Dienste. Sie können dieses Token auf verschiedene Weise erhalten:

Our ArcGIS token challenge sample shows how to create this credential in response to an authentication challenge. You can also create and add a credential to the AuthenticationManager before accessing secured services.

Unser Beispiel für Arcgis Token Challenge zeigt, wie diese Anmeldeinformationen als Reaktion auf eine Authentifizierungs -Herausforderung erstellt werden können. Sie können dem AuthenticationManager auch eine Anmeldeinformation erstellen und hinzufügen, bevor Sie auf gesicherte Dienste zugreifen.

PregeneratedTokenCredential (200.5+)

PregeneratedTokenCredential (200,5+)

This replaces ArcGISTokenCredentials created by the token-string constructor.

Dies ersetzt ArcgistokenCredentials, die vom Token-String-Konstruktor erstellt wurden.

PregeneratedTokenCredential accesses token-secured ArcGIS content and services using an independently generated token. This credential type gives you flexibility when integrating with custom authentication systems. Use it when you:

PregeneratedTokencedential Accesses-Token-sicherer ArcGIS-Inhalt und -Dienste mit einem unabhängig generierten Token. Dieser Anmeldeinformationsart bietet Ihnen Flexibilität bei der Integration in benutzerdefinierte Authentifizierungssysteme. Verwenden Sie es, wenn Sie:

New Supporting APIs

Neue unterstützende APIs

Beyond the credential types themselves, several supporting APIs have been added to enhance flexibility and control.

Abgesehen von den Anmeldeinformationen selbst wurden mehrere unterstützende APIs hinzugefügt, um die Flexibilität und Kontrolle zu verbessern.

Server Certificate Validation (200.6+)

Server -Zertifikat -Validierung (200.6+)

When working with HTTPS services, you can now customize how SSL/TLS certificates are validated. Specify a custom callback when configuring HTTP settings to examine all SSL connections made by the Maps SDK.

Bei der Arbeit mit HTTPS -Diensten können Sie jetzt anpassen, wie SSL/TLS -Zertifikate validiert werden. Geben Sie bei der Konfiguration von HTTP -Einstellungen einen benutzerdefinierten Rückruf an, um alle SSL -Verbindungen zu untersuchen, die von den Maps SDK hergestellt wurden.

Server certificates are usually validated by the operating system using default policies and known Certificate Authorities, but your own validator can accept or reject connections based on custom criteria. For example:

Serverzertifikate werden normalerweise vom Betriebssystem unter Verwendung von Standardrichtlinien und bekannten Zertifikatbehörden validiert. Ihr eigener Validator kann jedoch Verbindungen basierend auf benutzerdefinierten Kriterien akzeptieren oder ablehnen. Zum Beispiel:

The callback uses the standard .NET RemoteCertificateValidationCallback signature. For more information including code examples, see Microsoft’s guide to custom X509Certificate validation.

Der Rückruf verwendet die Standard .NET remoteCertificateValidationCallback -Signatur. Weitere Informationen einschließlich Code -Beispiele finden Sie unter Microsoft's Guide zur benutzerdefinierten X509Certificate -Validierung.

IHttpMessageInterceptor (200.5+)

IhttpMessageInterceptor (200.5+)

The new IHttpMessageInterceptor interface allows you to monitor, modify, or even mock HTTP requests and responses. This powerful capability can be configured globally when configuring HTTP settings on startup. Common use cases include:

Mit der neuen IHTTPMessageInterceptor -Schnittstelle können Sie HTTP -Anforderungen und Antworten überwachen, ändern oder sogar verspotteten. Diese leistungsstarke Funktion kann beim Konfigurieren von HTTP -Einstellungen beim Start global konfiguriert werden. Gemeinsame Anwendungsfälle umfassen:

Logging and Diagnostics: Log request and response details for monitoring and debugging:

Protokollierung und Diagnostik: Protokollanforderung und Antwortdetails zum Überwachen und Debuggen:

import logging

Protokollierung importieren

logger = logging.getLogger(__name__)

logger = logging.getLogger (__ name__)

class MessageInterceptor(IHttpMessageInterceptor):

Klasse messageInterceptor (iHttpMessageInterceptor):

"""Logs request and response details to the console."""

"" "Anfrage und Antwortdetails an der Konsole" "" "" "" ""

def OnRequest(self, request, cancellationToken):

definitiv (Selbst, Anfrage, StornierungToken):

"""Called before a request is sent."""

"" "Angerufen, bevor eine Anfrage gesendet wird." "" "

logger.info(f"Request: {request.Method} {request.RequestUri}")

logger.info (f "request: {request.method} {request.requesturi}")

for header in request.Headers:

Für Header in Request.Headerers:

logger.info(f" Header: {header}")

logger.info (f "Header: {Header}")

async def main():

Async def Main ():

"""Main function to configure and run the message interceptor."""

"" "Hauptfunktion zum Konfigurieren und Ausführen des Nachrichtenabfangs." "" "

message_interceptor = MessageInterceptor()

Message_Interceptor = MessageInterceptor ()

http_settings = HttpSettings.Builder().AddMessageInterceptor(message_interceptor).Build()

http_setings = httpettings.builder (). addMessageInterceptor (Message_Interceptor) .build ()

async with AuthenticationManager.CreateInstanceAsync(credentials, http_settings) as auth_manager:

Async mit AuthenticationManager

user = await ArcGISUser.CurrentUserAsync(auth_manager)

user = wartet arcgisuser.currentuserasync (auth_manager)

logger.info(f"Logged in as: {user.Username}")

logger.info (f "Angemeldet als: {user.username}")

if __name__ == "__main__":

Wenn __name__ == "__main__":

logging.basicConfig(level=logging.INFO, format='%(asctime

logging.basicconfig (Level = logging.info, format = '%(asctime