Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Verwenden Sie den OAuth On-Behalf-Of (OBO)-Fluss, wenn ein Upstreamclient einen Agent für einen angemeldeten Benutzer aufruft und der Agent eine benutzerdefinierte API für diesen Benutzer aufruft.
Der Agent überprüft zuerst das Eingehende Zugriffstoken und leitet dann denselben Autorisierungsheader an das Sidecar weiter. Das Sidecar verwendet seine konfigurierten Anmeldeinformationen, um einen nachgeschalteten Autorisierungsheader für diesen Benutzer abzurufen.
Voraussetzungen
- Abschluss von Authentifizieren von Benutzern mit dem Auth SDK Sidecar, einschließlich der Einwilligung, dass der vorgelagerte Client den Agenten aufrufen darf.
- Ein delegierter Bereich, der von der nachgelagerten API verfügbar gemacht wird.
- Einwilligung, dass der Agent diese API für den Benutzer aufrufen darf.
Zugriff konfigurieren
- Machen Sie einen delegierten Bereich für die benutzerdefinierte API verfügbar.
- Deklarieren Sie den Bereich in
requiredResourceAccessdes Blueprints. - Holen Sie die Einwilligung des Benutzers oder Administrators ein, dass die Agentidentität diesen Bereich verwenden darf.
- Konfigurieren Sie die API und den Scope im Sidecar.
Konfigurieren des Sidecars
Hinzufügen eines delegierten Profils für die benutzerdefinierte API:
{
"DownstreamApis": {
"custom-api": {
"BaseUrl": "https://api.contoso.com/",
"Scopes": [
"api://<custom-api-client-id>/<delegated-scope>"
]
}
}
}
Verwenden Sie die freigegebene Client-ID, und lassen Sie Identitätsüberschreibungen deaktiviert, wie unter Konfigurieren von Auth SDK Sidecar beschrieben.
Abrufen eines nachgelagerten Tokens
Leiten Sie das für die Agent-API ausgestellte Token weiter:
GET /AuthorizationHeader/custom-api
Authorization: ******
Senden Sie den zurückgegebenen authorizationHeader an die benutzerdefinierte API. Die benutzerdefinierte API muss das Token überprüfen und den erforderlichen Bereich und die Benutzerautorisierung erzwingen.
Senden Sie das eingehende Token nicht direkt an die benutzerdefinierte API. Er ist für den Agent und nicht für die nachgelagerte Ressource vorgesehen. Geben Sie keinen Autorisierungsheader zurück oder protokollieren diesen.
Aufrufen des Sidecars und der benutzerdefinierten API
Im folgenden Beispiel wird der Eingehende Benutzerautorisierungsheader an das Sidecar weitergeleitet, der nachgeschaltete Autorisierungsheader gelesen und die benutzerdefinierte API aufgerufen:
import requests
SIDECAR_URL = "http://localhost:5000"
inbound_auth_header = "<authorization-header-from-agent-request>"
sidecar_response = requests.get(
f"{SIDECAR_URL}/AuthorizationHeader/custom-api",
headers={"Authorization": inbound_auth_header},
timeout=5,
)
if sidecar_response.status_code in (401, 403):
raise PermissionError("The sidecar rejected the user token or OBO request.")
sidecar_response.raise_for_status()
authorization_header = sidecar_response.json()["authorizationHeader"]
api_response = requests.get(
"https://api.contoso.com/user-data",
headers={"Authorization": authorization_header},
timeout=10,
)
api_response.raise_for_status()
response_body = api_response.json()
Behalten Sie SIDECAR_URL im Loopback des freigegebenen Netzwerk-Namespaces bei. Ersetzen Sie den Platzhalter für den Autorisierungsheader durch den vollständigen Authorization Header, der vom Agent empfangen wird. Verarbeiten Sie responseBody gemäß der Reaktionsvereinbarung der benutzerdefinierten API.
Behandeln Sie die Sidecar-Antwort als Anmeldeinformation. Protokollieren Sie authorizationHeader nicht und geben Sie ihn nicht zurück.
Stellen Sie sicher, dass die API den delegierten Bereich und den Zugriff des Benutzers erzwingt. Wenn OBO meldet, dass die Zustimmung fehlt, überprüfen Sie den vorgelagerten Zugriff auf den Agenten getrennt von der nachgeschalteten Zustimmung; der OBO-Austausch kann keine Zustimmungsaufforderung anzeigen.