Suchergebnisse :

×
Treffen Sie uns unter WordCamp Europa | ShopTalk | DrupalCon Konferenzen zur Erkundung unserer Lösungen. Weitere Informationen

OAuth-API-Dokumentation

Autorisierungscode gewähren

  • Autorisierungsanfrage

    • Die Anwendung muss zunächst entscheiden, welche Berechtigungen sie anfordert, und den Benutzer dann an einen Browser weiterleiten, um seine Erlaubnis einzuholen. Um diesen Autorisierungsfluss zu initiieren, erstellen Sie eine URL wie unten und leiten Sie den Browser des Endbenutzers auf die URL um: 
      •             BESTELLE http://<wp_base_url>/wp-json/moserver/authorize
            ?response_type=code
            &client_id= <client_id_goes_here>
            &redirect_uri= <callback_url>
            &scope= <permissions_requesting>
            &state= <security_token>
    • Antworttyp=Code: Die Art der Antwort, die Sie erwarten. Um den Autorisierungscode zu erhalten, muss dieser einen Wert haben Code. Dadurch wird dem Autorisierungsserver mitgeteilt, dass die Anwendung den Autorisierungsfluss initiiert.
    • Kunden ID : Die vom OAuth-Anbieter bereitgestellte Client-ID.
    • Redirect_uri: Rückruf-URL, zu der der Benutzer weitergeleitet wird, sobald er den Zugriff auf Ihre App zulässt oder verbietet.
    • Umfang : Eine oder mehrere durch Leerzeichen getrennte Zeichenfolgen, die die von Ihrer Anwendung angeforderte Berechtigung angeben.
    • Zustand : Die Anwendung generiert eine zufällige Zeichenfolge und fügt sie in die Anfrage ein. Anschließend sollte überprüft werden, ob derselbe Wert zurückgegeben wird, nachdem der Benutzer die App autorisiert hat.
    • Wenn der Benutzer den Zugriff auf Ihre App zulässt, wird sein Browser auf die angegebene Weiterleitungs-URL umgeleitet und die Anfrage enthält Code und Zustand Parameter in der Abfragezeichenfolge.
    • Beispielsweise kann der Benutzer zu einer URL wie z. B. zurückgeleitet werden
      •               https://example-app.com/redirect
              ?code=<authorization-code>
              &state=<security_token>
    • Das Code ist ein Autorisierungscode, der gegen ein Zugriffstoken ausgetauscht werden kann. Es wird vom Autorisierungsserver generiert und ist relativ kurzlebig.
    • Das Zustand ist das gleiche Sicherheitstoken, das die Anwendung ursprünglich in der Anfrage festgelegt hat.

  • Token-Anfrage

    • Wenn der Endbenutzer Ihrer App Zugriff gewährt hat und Sie einen Autorisierungscode erhalten, können Sie den Autorisierungscode gegen ein Zugriffstoken austauschen, indem Sie eine POST-Anfrage an den Token-Endpunkt stellen.
    • Das Folgende ist ein Beispiel für eine POST-Anfrage:
      •               jetzt lesen http://<wp_base_url>/wp-json/moserver/token
              Content-Type: application/x-www-form-urlencoded
         
              grant_type=authorization_code&
              code=<authorization_code>&
              client_id=<client_id>&
              client_secret=<clientSecret>&
              redirect_uri=<redirect_uri>
    • Hier finden Sie die Beschreibung für jeden Anforderungsparameter.
      • grant_type=authorization_code: Die Art des Zuschusses, den Sie gewähren. Dies zeigt an, dass die Anwendung den Autorisierungscode-Gewährungstyp verwendet.
      • Code: Der im vorherigen Schritt erhaltene Autorisierungscode ist hier enthalten.
      • Redirect_uri: Dieselbe URL, die zuvor in der Autorisierungsanfrage angegeben wurde.
      • Kunden ID : Die vom OAuth-Anbieter bereitgestellte Client-ID.
      • client_secret: Das vom OAuth-Anbieter bereitgestellte Client-Geheimnis.
    • Am Token-Endpunkt werden alle Parameter in der Anfrage überprüft, um sicherzustellen, dass der Code nicht abgelaufen ist und die Client-ID und das Geheimnis übereinstimmen. Wenn die Anfrage erfolgreich ist, wird ein Zugriffstoken generiert und in der Antwort zurückgegeben: 
      •               HTTP/1.1 200 OK Content-Type: application/json Cache-Control: no-store { „access_token“: „hkjher92u9eu2u3uihi2eh9293“, „token_type“: „bearer“, „expires_in“:3600, „scope“: „profile“, „id_token“: „“ }
    • Hier ist die Beschreibung für jeden Parameter, der in der Antwort empfangen wird.
      • Zugangstoken : Zugriffstoken für den Userinfo-Endpunkt.
      • token_type: Wert des OAuth 2.0-Tokentyps. Der Wert muss sein Träger.
      • Läuft ab in : Die Ablaufzeit für das Zugriffstoken.
      • Umfang: Eine oder mehrere durch Leerzeichen getrennte Zeichenfolgen, die die von Ihrer Anwendung angeforderte Berechtigung angeben.
      • id_token: Das ID-Token ist ein Sicherheitstoken, das Ansprüche über die Authentifizierung eines Endbenutzers durch einen Autorisierungsserver bei Verwendung eines Clients sowie möglicherweise andere angeforderte Ansprüche enthält
    • Wenn die Anfrage fehlschlägt, hat die Antwort den Status 404 Bad Request und wird folgenden Inhalt haben: 
      •               „error“: „invalid_request“, „error_description“: „Eine detailliertere Beschreibung des Fehlers für den Entwickler Ihrer App.“

  • Ressourcenanforderung

    • Wenn die Token-Anfrage erfolgreich ist, erhalten Sie Zugangstoken in der Antwort, mit der über die API auf die geschützten Ressourcen zugegriffen werden kann.
    • Benutzerinfo-Anfrage: Das Folgende ist ein nicht formatives Beispiel einer Userinfo-Anfrage: 
      •                    BESTELLE http://<wp_base_url>/wp-json/moserver/resource
                   Host: server.example.com
                   Authorization: Bearer <access_token>
    • Der Ressourcenserver validiert und verifiziert das Zugriffstoken und prüft, ob es nicht abgelaufen ist. Wenn die Ressourcenanforderung gültig ist, gibt der Ressourcenserver die Ansprüche zurück, die durch ein JSON-Objekt dargestellt werden, das eine Sammlung von Namens- und Wertpaaren für die Ansprüche enthält.
    • Erfolgreiche Userinfo-Antwort:
    • Die UserInfo-Ansprüche MÜSSEN als Mitglieder eines JSON-Objekts zurückgegeben werden.

      Unten ist das Beispiel: 
      •                 { „id“: „1“, „username“: „abc“, „first_name“: „xyz“, „last_name“: „example“, „picture“: „https://example.com/-kwtzesU/photo .jpg", "email": "abc@example.com", "locale": "en",... }

Implizite Codegewährung

  • Autorisierungsanfrage

    • Die Anwendung muss zunächst entscheiden, welche Berechtigungen sie anfordert, und den Benutzer dann an einen Browser weiterleiten, um seine Erlaubnis einzuholen. Um diesen impliziten Fluss zu initiieren, bilden Sie eine URL wie unten und leiten Sie den Browser des Endbenutzers auf die URL um: 
      •               Erhalten Sie  http://<wp_base_url>/wp-json/moserver/authorize 
              ?response_type=token
              &client_id= <client_id_goes_here>
              &redirect_uri= <callback_url>
              &scope= <permissions_requesting>
              &state= <security_token>
    • Antworttyp=Token: Die Art der Antwort, die Sie erwarten. Dadurch wird dem Autorisierungsserver mitgeteilt, dass die Anwendung einen impliziten Fluss initiiert. Beachten Sie den Unterschied zum Autorisierungscode-Ablauf, bei dem dieser Wert auf Code festgelegt ist.
    • Kunden ID : Die vom OAuth-Anbieter bereitgestellte Client-ID.
    • Redirect_uri: Rückruf-URL, zu der der Benutzer weitergeleitet wird, sobald er den Zugriff auf Ihre App zulässt oder verbietet.
    • Umfang : Eine oder mehrere durch Leerzeichen getrennte Zeichenfolgen, die die von Ihrer Anwendung angeforderte Berechtigung angeben.
    • Zustand : Die Anwendung generiert eine zufällige Zeichenfolge und fügt sie in die Anfrage ein. Anschließend sollte überprüft werden, ob derselbe Wert zurückgegeben wird, nachdem der Benutzer die App autorisiert hat.
    • Wenn der Benutzer den Zugriff auf Ihre App zulässt, wird sein Browser auf die angegebene Weiterleitungs-URL umgeleitet und die Anfrage enthält Zeichen und Zustand Parameter in der Abfragezeichenfolge.
    • Beispielsweise kann der Benutzer zu einer Rückruf-URL wie z. B. zurückgeleitet werden 
      •         https://callback-url?
        #access_token=<access_token>
        &token_type=Bearer
        &expires_in=3600
        &scope=<permissions_requesting>
    • Beachten Sie die beiden Hauptunterschiede zwischen diesem und dem Autorisierungscode-Ablauf: Das Zugriffstoken wird anstelle des Autorisierungscodes in der Antwort zurückgegeben.
    • Der Client kann dann die verwenden Zugangstoken um vom Ressourcenserver aus auf geschützte Ressourcen zuzugreifen.
      Hier ist die Beschreibung für jeden Parameter, der in der Antwort empfangen wird.
      • Zugangstoken : Zugriffstoken für den Userinfo-Endpunkt.
      • token_type: Wert des OAuth 2.0-Tokentyps. Der Wert muss sein Träger.
      • Läuft ab in : Die Ablaufzeit für das Zugriffstoken.
      • Umfang: Eine oder mehrere durch Leerzeichen getrennte Zeichenfolgen, die die von Ihrer Anwendung angeforderte Berechtigung angeben.

  • Ressourcenanforderung

    • Der UserInfo-Endpunkt ist eine OAuth 2.0-geschützte Ressource, die Ansprüche über den authentifizierten Endbenutzer zurückgibt. Die zurückgegebenen Ansprüche werden durch ein JSON-Objekt dargestellt, das eine Sammlung von Namens- und Wertpaaren für die Ansprüche enthält.
    • Benutzerinfo-Anfrage: Das Folgende ist ein nicht formatives Beispiel einer Userinfo-Anfrage: 
      •              BESTELLE http://<wp_base_url>/wp-json/moserver/resource
             Host: server.example.com
             Authorization: Bearer <access_token>
    • Erfolgreiche Userinfo-Antwort:
    • Die UserInfo-Ansprüche MÜSSEN als Mitglieder eines JSON-Objekts zurückgegeben werden.

      Unten ist das Beispiel: 
      •           { „id“: „1“, „username“: „abc“, „first_name“: „xyz“, „last_name“: „example“, „picture“: „https://example.com/-kwtzesU/photo .jpg", "email": "abc@example.com", "locale": "en",... }

Passwortgewährung

  • Der Gewährungstyp „Ressourcenbesitzer-Passwort“ (oder „Passwort“) wird meist in Fällen verwendet, in denen die App sehr vertrauenswürdig ist. In dieser Konfiguration gibt der Benutzer seine Ressourcenserver-Anmeldeinformationen (Benutzername/Passwort) an die Client-App weiter, die ihm eine Zugriffstoken-Anfrage sendet.

  • Token-Anfrage

    • Die Passwortgewährung ist eine der einfachsten OAuth-Gewährungen und umfasst nur einen Schritt: Die Anwendung präsentiert ein herkömmliches Anmeldeformular mit Benutzername und Passwort, um die Anmeldeinformationen des Benutzers zu sammeln, und sendet eine POST-Anfrage an den Server, um das Passwort gegen ein Zugriffstoken auszutauschen. Die von der Anwendung gestellte POST-Anfrage sieht wie im folgenden Beispiel aus. 
      •           jetzt lesen http://<wp_base_url>/wp-json/moserver/token
          Host: authorization-server.com
          Content-type: application/x-www-form-urlencoded
  
          grant_type=password
          &username=exampleuser
          &password=12345678
          &client_id=xxxxxxxxxx
          &client_secret=xxxxxxxxxx
    • Die POST-Parameter in dieser Anfrage werden unten erläutert.
      • grant_type=Passwort: Dadurch wird dem Server mitgeteilt, dass wir den Typ „Passwortgewährung“ verwenden
      • Benutzername = Der Benutzername des Benutzers, den er in der Anwendung eingegeben hat
      • Passwort = Das Passwort des Benutzers, das er in der Anwendung eingegeben hat
      • client_id= Die öffentliche Kennung der Anwendung, die der Entwickler bei der Registrierung erhalten hat
      • client_secret= Das vom OAuth-Anbieter bereitgestellte Client-Geheimnis.
    • Am Token-Endpunkt werden alle Parameter in der Anfrage überprüft, um sicherzustellen, dass der Code nicht abgelaufen ist und die Client-ID und das Geheimnis übereinstimmen. Wenn die Anfrage erfolgreich ist, wird ein Zugriffstoken generiert und in der Antwort zurückgegeben: 
      •             HTTP/1.1 200 OK Content-Type: application/json Cache-Control: no-store { „access_token“: „hkjher92u9eu2u3uihi2eh9293“, „token_type“: „bearer“, „expires_in“:3600, „scope“: „profile“, „id_token“: „“ }
    • Der Client kann dann die verwenden Zugangstoken um vom Ressourcenserver aus auf geschützte Ressourcen zuzugreifen.
      Hier ist die Beschreibung für jeden Parameter, der in der Antwort empfangen wird.
      • Zugangstoken : Zugriffstoken für den Userinfo-Endpunkt.
      • token_type: Wert des OAuth 2.0-Tokentyps. Der Wert muss sein Träger.
      • Läuft ab in : Die Ablaufzeit für das Zugriffstoken.
      • Umfang: Eine oder mehrere durch Leerzeichen getrennte Zeichenfolgen, die die von Ihrer Anwendung angeforderte Berechtigung angeben.

  • Ressourcenanforderung

    • Der UserInfo-Endpunkt ist eine OAuth 2.0-geschützte Ressource, die Ansprüche über den authentifizierten Endbenutzer zurückgibt. Die zurückgegebenen Ansprüche werden durch ein JSON-Objekt dargestellt, das eine Sammlung von Namens- und Wertpaaren für die Ansprüche enthält.
    • Benutzerinfo-Anfrage: Das Folgende ist ein nicht formatives Beispiel einer Userinfo-Anfrage: 
      •              BESTELLE http://<wp_base_url>/wp-json/moserver/resource
             Host: server.example.com
             Authorization: Bearer <access_token>
    • Erfolgreiche Userinfo-Antwort:
    • Die UserInfo-Ansprüche MÜSSEN als Mitglieder eines JSON-Objekts zurückgegeben werden.

      Unten ist das Beispiel: 
      •           { „id“: „1“, „username“: „abc“, „first_name“: „xyz“, „last_name“: „example“, „picture“: „https://example.com/-kwtzesU/photo .jpg", "email": "abc@example.com", "locale": "en",... }

Gewährung von Client-Anmeldeinformationen

  • Die Gewährung von Client-Anmeldeinformationen kann für die Maschine-zu-Maschine-Authentifizierung verwendet werden. Bei dieser Gewährung wird kein bestimmter Benutzer autorisiert, sondern die Anmeldeinformationen werden überprüft und ein generisches access_token wird zurückgegeben.

  • Token-Anfrage

    • Um ein Zugriffstoken zu erhalten, sendet der Client einen API-Aufruf mit den Werten für Client-ID und Client-Geheimnis, die er wie folgt von einer registrierten Entwickler-App erhalten hat. 
      •           jetzt lesen http://<wp_base_url>/wp-json/moserver/token
              Content-Type: application/x-www-form-urlencoded
         
              grant_type=client_credentials&
              client_id=<client_id>&
              client_secret=<clientSecret>&
              redirect_uri=<redirect_uri>&
              scope=<permisssions_requested>

    • Anfrageparameter:
      • Die POST-Anfrageparameter werden unten erläutert.
      • grant_type=client_credentials: Dadurch wird dem Server mitgeteilt, dass wir den Gewährungstyp für Client-Anmeldeinformationen verwenden.
      • client_id= Die öffentliche Kennung der Anwendung, die der Entwickler bei der Registrierung erhalten hat.
      • client_secret: Das vom OAuth-Anbieter bereitgestellte Client-Geheimnis.
      • Redirect_uri: Rückruf-URL, zu der der Benutzer weitergeleitet wird, sobald er den Zugriff auf Ihre App zulässt oder verbietet.
      • Umfang : Eine oder mehrere durch Leerzeichen getrennte Zeichenfolgen, die die von Ihrer Anwendung angeforderte Berechtigung angeben.
    • Wenn die Anmeldeinformationen gültig sind, erhält die Anwendung ein signiertes JSON-Web-Token oder Zugriffstoken, den Typ des Tokens (Bearer) und die Zeitspanne, in der es in Unix-Zeit abläuft, zurück.
    • Beispielantwort
      •         { "Zugangstoken": , „expires_in“: 600, „token_type“: „Bearer“ }
    • Antwortelemente:
      • Zugangstoken : Zugriffstoken für den Userinfo-Endpunkt.
      • verfällt in Die Ablaufzeit für das Zugriffstoken.
      • token_type: Wert des OAuth 2.0-Tokentyps. Der Wert muss sein Träger.

  • Ressourcenanforderung

    • Das Gewährung von Client-Anmeldeinformationen nicht unterstützt Ressourcenanforderung.

    Token-Zuteilung aktualisieren

    • Ein Aktualisierungstoken ermöglicht es der Anwendung, ein neues Zugriffstoken oder ID-Token auszustellen, ohne den Benutzer erneut authentifizieren zu müssen. Dies funktioniert, solange das Refresh-Token nicht widerrufen wurde.

    • Token-Anfrage

      • Die Antwort auf die Token-Anfrage sollte ein Zugriffstoken und ein Aktualisierungstoken enthalten. 
        •             { "access_token": "etMv23....429hiU32Hri", "refresh_token": "GEbRxBN...edjnXbL", "token_type": "Bearer" }
      • Verwenden Sie ein Aktualisierungstoken:
      • Um das Aktualisierungstoken, das Sie erhalten haben, gegen ein neues Zugriffstoken auszutauschen, stellen Sie eine POST-Anfrage an den Token-Endpunkt mit grant_type=refresh_token wie folgt. 
        •               jetzt lesen http://<wp_base_url>/wp-json/moserver/token
              Content-Type: application/x-www-form-urlencoded
              grant_type=refresh_token&
              client_id=<client_id>&
              client_secret=<client_secret>&
              refresh_token=<refresh_token>
      • Hier finden Sie die Beschreibung für jeden Anforderungsparameter.
        • grant_type=refresh_token: Dadurch wird dem Server mitgeteilt, dass wir den Aktualisierungstoken-Gewährungstyp verwenden.
        • client_id= Die öffentliche Kennung der Anwendung, die der Entwickler bei der Registrierung erhalten hat.
        • client_secret: Das vom OAuth-Anbieter bereitgestellte Client-Geheimnis.
        • Refresh_token: Das zu verwendende Aktualisierungstoken.
      • Die Antwort enthält ein neues Zugriffstoken, seinen Typ, seine Lebensdauer (in Sekunden) und die gewährten Bereiche. Wenn der Umfang des ursprünglichen Tokens openid enthielt, wird auch ein neues ID-Token in der Antwort enthalten sein.
      • Die Antwort enthält die folgenden Parameter:
        •             { „access_token“: „eyJ...MoQ“, „expires_in“: 86400, „scope“: , „id_token“: „eyJ...0NE“, „token_type“: „Bearer“ }

    Widerrufen Sie ein Aktualisierungstoken

    • Da Refresh-Tokens nie ablaufen, ist es wichtig, sie widerrufen zu können, falls sie kompromittiert werden.
    • Um ein Aktualisierungstoken zu widerrufen, können Sie eine senden jetzt lesen Anfrage an den Token-Endpunkt wie folgt. 
      •             jetzt lesen http://<wp_base_url>/wp-json/moserver/token
            Content-Type: application/x-www-form-urlencoded
            client_id=<client_id>&
            client_secret=<client_secret>&
            refresh_token=<refresh_token>

Demo Version

Wenn Sie nicht finden, was Sie suchen, kontaktieren Sie uns bitte unter info@miniorange.com oder rufen Sie uns an +1 978 658 9387 um eine Antwort auf Ihre Frage zum Wordpress OAuth-Server zu finden.

Sehen Sie sich die Videos an, um mehr zu erfahren  Demo ansehen
Angesagte Suchanfragen:
Hallo!

Brauchen Sie Hilfe? Wir sind hier!
Support
Kontaktieren Sie den miniOrange-Support
Erfolg

Vielen Dank für Ihre Anfrage.

Wenn Sie innerhalb von 24 Stunden nichts von uns hören, können Sie gerne eine Folge-E-Mail an senden info@xecurify.com