prepareUserCredentialRequestWithCodeFlow
Versionshinweise | 21.1.12, 21.2 |
---|
Code
String OAuthUtils.prepareUserCredentialRequestWithCodeFlow(String audience, String audienceIdentifier, String scope, String clientId, String clientSecret, String authorizationEndpointUrl, String accessTokenEndpointUrl)
Beschreibung
Bereitet die Ausführung des OAuth 2.0 Authorization Code Grant Flow (siehe RFC 6749 Abschnitt 1.3.1) mit den angegebenen Parametern vor. Die zurückgegebene URL muss von einem Benutzer in einem Browser geöffnet werden, um die Autorisierung durchzuführen.
Das daraus entstehende OAuth Credential wird dann als benutzerspezifisches Credential für den aktuellen Benutzer unter der angegebenen Zielgruppe und der Bezeichnung innerhalb der Zielgruppe abgelegt. Da die Autorisierung bei diesem Flow asynchron in einem Browser eines Benutzers erfolgen muss, werden etwaige Fehler bei der Durchführung im Browser des Benutzers gemeldet und nicht in diesem Skript.
Parameter
audience
– Die Zielgruppe der OAuth-Zugangsdaten.audienceIdentifier
– Die Bezeichnung innerhalb der Zielgruppe der OAuth-Zugangsdaten.scope
– Eine mit Leerzeichen getrennte Liste von Scopes, die angefragt werden sollen.clientId
– Die OAuth 2.0 Client ID um sich gegenüber dem Authorization Server zu authentifizieren.clientSecret
– Das OAuth 2.0 Client Secret um sich gegenüber dem Authorization Server zu authentifizieren.authorizationEndpointUrl
– Die URL des Authorization Endpoints des OAuth 2.0 Authorization Servers.accessTokenEndpointUrl
– Die URL des Access Token Endpoints (üblicherweise nur "Token Endpoint" genannt) des OAuth 2.0 Authorization Servers.
Rückgabe
Die URL zum Auslösen des OAuth-Autorisierungs-Flows.
Leiten Sie einen Benutzer an, diese URL in einem Browser zu öffnen.
Beispiele
String audience = "example-com-api";
String audienceIdentifier = "pricing-api";
String scope = "read_prices change_prices";
String clientId = "demo-pricing-client";
String clientSecret = "secretValue";
String authorizationEndpointUrl = "https://auth.example.com/authorize";
String accessTokenEndpointUrl = "https://auth.example.com/token";
String authorizationUrl = OAuthUtils.prepareUserCredentialRequestWithCodeFlow(audience, audienceIdentifier, scope, clientId, clientSecret, authorizationEndpointUrl, accessTokenEndpointUrl);
// Nach dieser Stelle muss ein Benutzer darum gebeten werden, die authorizationUrl in einem Browser zu öffnen, um die Autorisierung durchzuführen.