So nutzen Sie die API-Aufrufe des Login Widget SDK

Sie können die API-Aufrufe des Login Widget SDK getrennt vom Login-Widget nutzen, wenn Sie:

  • Ihr eigenes Widget-Design verwenden möchten
  • den Ablauf des Login-Widgets nur teilweise implementieren möchten

Hinweis
Nicht alle API-Aufrufe unterstützen dieses Szenario.

Code-Initialisierung

Um die API-Aufrufe des Login Widget SDK ohne Widget zu verwenden, binden Sie den folgenden Code in den <body>-Tag ein:

Copy
Full screen
Small screen
    <script>
    const api = new XsollaLogin.Api({
      projectId: 'someProjectId'
    });
    </script>

    Initialisierungscode bei Verwendung eines npm-Pakets:

    Copy
    Full screen
    Small screen
      import XsollaLogin from '@xsolla/login-sdk';
      const api = new XsollaLogin.Api({
        projectId: 'someProjectId'
      });

      Die folgenden Parameter werden im Initialisierungscode übermittelt:

      ParameterTypBeschreibung
      projectId
      stringID Ihres Login-Projekts aus dem Kundenportal. Erforderlich.
      fullLocale
      stringSprache der Benutzeroberfläche und eine Region im Format <language code>_<country code>, wobei:Die folgenden Sprachen werden unterstützt: Arabisch (ar_AE), Bulgarisch (bg_BG), Tschechisch (cz_CZ), Englisch (en_XX), Deutsch (de_DE), Spanisch (es_ES), Französisch (fr_FR), Hebräisch (he_IL), Italienisch (it_IT), Japanisch (ja_JP), Koreanisch (ko_KR), Polnisch (pl_PL), Portugiesisch (pt_BR), Rumänisch (ro_RO), Russisch (ru_RU), Thailändisch (th_TH), Türkisch (tr_TR), Vietnamesisch (vi_VN), Vereinfachtes Chinesisch (zh_CN), Traditionelles Chinesisch (zh_TW).
      Der Parameter beeinflusst die Reihenfolge der sozialen Netzwerke, da diese nach deren Benutzungshäufigkeit in der angegebenen Region angeordnet sind. Außerdem bestimmt er die Sprache, in der die E-Mails an die Nutzer versendet werden.
      callbackUrl
      stringDie URL, mit der der Xsolla-Login-Server arbeitet, sofern die Anmeldung oder Registrierung erfolgreich war.
      emailTemplate
      stringDer Name des Projekts, in dessen Namen die E-Mails an die Benutzer gesendet werden.
      payload
      stringZusätzliche Daten, die in einem Code übermittelt werden können. Diese Daten werden nach erfolgreicher Anmeldung dem Benutzer-JWT hinzugefügt.
      with_logout
      booleanLegt fest, ob ältere Token bei einer erneuten Anmeldung widerrufen werden sollen. false ist voreingestellt.
      clientId
      stringID der Client-App. Wird übermittelt, wenn die auf dem OAuth 2.0-Protokoll basierende Authentifizierung in der App zum Einsatz kommt.
      scope
      stringZusätzliche Angaben über ein von der Anwendung angefordertes Benutzerkonto. Wird übermittelt, wenn die auf dem OAuth 2.0-Protokoll basierende Authentifizierung in der App zum Einsatz kommt. Mögliche Werte:
      • email – Zusätzliche Abfrage der E-Mail-Adresse, wenn sich der Benutzer über ein soziales Netzwerk anmeldet.
      • offline – Automatische Aktualisierung des JWT nach Ablauf seiner Gültigkeit.
      • playfab – Der Parameter SessionTicket wird automatisch an ein JWT übermittelt, wenn die Benutzerdaten in PlayFab gespeichert sind.
      Sie können auch Ihre eigenen Parameter angeben. Der Xsolla-Login-Server verarbeitet sie nicht, sondern gibt sie in einem JWT zurück.
      state
      stringEine zusätzliche Benutzerverifizierung, um beispielsweise CSRF-Attacken zu verhindern. Mindestlänge: 8 Zeichen.
      redirectUrl
      stringDie URL, zu der der Benutzer weitergeleitet wird, nachdem er sein Konto bestätigt, sich angemeldet oder das Passwort zurückgesetzt hat.
      booleanOb die Bestätigung der passwortlosen Authentifizierung per Klick auf einen Link in der E-Mail deaktiviert werden soll, wenn sich Benutzer ohne Passwort per E-Mail-Adresse oder Telefonnummer anmelden. false ist voreingestellt.
      is_oauth2
      booleanLegt fest, ob die auf dem OAuth 2.0-Protokoll basierende Authentifizierung für Nutzer zum Einsatz kommt. false ist voreingestellt.

      API-Aufrufe

      Folgende API-Aufrufe des Login Widget SDK lassen sich auch ohne Login-Widget nutzen:

      Benutzerregistrierung per Passwort

      AufrufBeschreibungParameter
      api.signup(userInfo);Registriert einen neuen Benutzer. Die Bentzerdaten werden während der Registrierung im userInfo-Objekt übermittelt. Der Token des registrierten Benutzers wird in der Antwort übermittelt.
      • email (string) — E-Mail-Adresse des Benutzers. Erforderlich.
      • username (string) — Benutzername. Erforderlich.
      • password (string) — Benutzerpasswort. Erforderlich.
      • nickname (string) — Nickname des Benutzers.

      Beispiel:

      Copy
      Full screen
      Small screen
        let result
        // Request
        api.signup({
          userInfo: {
            email: 'email@address.com',
            fields: {
              nickname: 'Johny'
            },
            password: 'password123',
            username: 'John'
          }
        }).then((res) => {
          result = res;
        })
        
        // Response
        result === {
          login_url: 'https://someurl.com?token=XXXXXXX'
        }

        Anmelden mit Passwort

        AufrufBeschreibungParameter
        api.login(credentials);Authentifiziert einen Benutzer anhand eines Passworts. Die für die Benutzeranmeldung erforderlichen Benutzerdaten werden im credentials-Objekt übermittelt. Der Token des authentifizierten Benutzers wird in der Antwort übermittelt.
        • username (string) – Benutzername, z. B.: John, oder eine E-Mail-Adresse, z. B.: email@address.com. Erforderlich.
        • password (string) – Benutzerpasswort. Erforderlich.

        Beispiel:

        Copy
        Full screen
        Small screen
          let result
          // Request
          api.login({
            credentials: {
              password: 'password123',
              username: 'email@address.com'
            }
          }).then((res) => {
            result = res;
          })
          
          // Response
          result === {
            login_url: 'https://someurl.com?token=XXXXXXX'
          }
          
          // Response with additional fields
          result === {
            ask_fields: [{
              confirmation_type: 'code' || 'link'
              name: 'phone_number'
              required: false
              step: 0 // Displays the position of the field in the data retrieval queue.
              type: 'phone'
              validation: {} // Custom validation
            }]
            login_url: 'https://someurl.com?token=XXXXXXX',
            token: 'sometoken'
          }

          Kontobestätigung

          AufrufBeschreibungParameter
          api.resendEmail(username);Sendet eine weitere E-Mail zur Bestätigung des Kontos. Um das Konto zu bestätigen, sollte der Benutzer auf den Link in der E-Mail klicken. Die E-Mail-Adresse des Benutzers wird im Objekt username übermittelt. Als Antwort wird der Standardcode 204 zurückgegeben.
          • username (string) – E-Mail-Adresse des Benutzers, z. B.: email@address.com. Erforderlich.

          Beispiel:

          Copy
          Full screen
          Small screen
            let result
            // Request
            api.resendEmail({
              username: 'email@address.com'
            }).then((res) => {
              res.code === 204;
            })

            Passwortlose Authentifizierung

            Ablauf für den Nutzer:

            1. Der Benutzer gibt seine Telefonnummer oder E-Mail-Adresse ein. Je nach den eingegebenen Anmeldedaten wird entweder api.phoneGetCode oder api.emailGetCode aufgerufen.
            2. Der Server empfängt die Daten und sendet einen Code per E-Mail oder SMS an den Benutzer. Wird beim Initialisieren des Codes der Parameter disableConfirmByLink=true (deaktiviert die Anmeldebestätigung über den Link in der E-Mail) übermittelt, wird für die automatische Weiterleitung des Benutzers nach dem Anklicken des Links der Aufruf api.getConfirmCode verwendet.
            3. Als Antwort auf den Aufruf api.phoneGetCode bzw. api.emailGetCode erhält man den Parameter operation_id, mit dem sich die Telefonnummer bzw. die E-Mail-Adresse durch den Aufruf api.loginWithPhoneCode bzw. api.loginWithEmailCode bestätigen lässt.
            4. Nachdem die E-Mail-Adresse bzw. die Telefonnummer erfolgreich bestätigt wurde, erhält man als Antwort die URL mit dem token-Parameter. Damit lassen sich zusätzliche Daten über den Benutzer abfragen.

            AufrufBeschreibungParameter
            api.phoneGetCode({ phone_number, link_url, isOauth2 });Sendet einen Bestätigungscode an die Telefonnummer. Der zur Bestätigung der Telefonnummer verwendete operation_id-Parameter wird in der Antwort zurückgegeben.
            • phone_number (string) – Telefonnummer für die passwortlose Authentifizierung.
            • link_url (string) – Bestätigungs-URL.
            • isOauth2 (boolean) – Ob die auf dem OAuth 2.0-Protokoll basierende Authentifizierung für Benutzer verwendet werden soll. Erforderlich.

            Beispiel:

            Copy
            Full screen
            Small screen
              let result
              // Request
              api.phoneGetCode({
                phone_number: '+somenumber',
                link_url: 'https://someurl.com',
                isOauth2: true
              }).then((res) => {
                result = res;
              })
              
              // Response
              result === {
                operation_id: '2334j255fdf13d515fgd1'
              }

              AufrufBeschreibungParameter
              api.phoneGetCode({ phone_number, link_url, isOauth2 });Sendet einen Bestätigungscode an die E-Mail-Adresse. Der zur Bestätigung der E-Mail-Adresse verwendete operation_id-Parameter wird in der Antwort zurückgegeben.
              • email (string) – E-Mail-Adresse für die passwortlose Authentifizierung.
              • link_url (string) – Bestätigungs-URL.
              • isOauth2 (boolean) – Ob die auf dem OAuth 2.0-Protokoll basierende Authentifizierung für Benutzer verwendet werden soll. Erforderlich.

              Beispiel:

              Copy
              Full screen
              Small screen
                let result
                // Request
                api.emailGetCode({
                  email: 'email@address.com',
                  link_url: 'https://someurl.com',
                  isOauth2: true
                }).then((res) => {
                  result = res;
                })
                
                // Response
                result === {
                  operation_id: '2334j255fdf13d515fgd1'
                }

                AufrufBeschreibungParameter
                api.getConfirmCode({ cancelToken, login, operation_id });Ruft einen Bestätigungscode ab, um den Benutzer nach Klick auf den Link automatisch weiterzuleiten.
                • cancelToken (string) – Individueller Token zum Beenden der Sitzung. Erforderlich.
                • login (string) – Telefonnummer oder E-Mail Adresse des Benutzers. Erforderlich.
                • operation_id (string) – Individuelle Kennung, die zur Bestätigung einer Telefonnummer oder E-Mail-Adresse eines Benutzers während einer laufenden Sitzung verwendet wird. Erforderlich.

                Beispiel:

                Copy
                Full screen
                Small screen
                  let result
                  // Request
                  const axiosCancelToken = Axios.CancelToken.source();
                  
                  api.getConfirmCode({
                    cancelToken: axiosCancelToken,
                    login: '+somenumber' || 'email@address.com',
                    operation_id: '334j255fdf13d515fgd1'
                  }).then((res) => {
                    result = res;
                  })
                  
                  // Response
                  result === {
                    code: 'string'
                  }
                  
                  // If the waiting time has elapsed, returns:
                  result === {
                    error: {
                      code: '010-050',
                      description: 'Deadline exceeded.'
                    }
                  }
                  
                  // If you no longer need to wait for verification through the link you can close the request waiting period:
                  axiosCancelToken.cancel();

                  AufrufBeschreibungParameter
                  api.loginWithPhoneCode({ phone_number, Code, operation_id, isOauth2 });Bestätigt die Telefonnummer. Als Antwort erhält man die URL mit dem Parameter token. Dieser wird bei der Abfrage zusätzlicher Daten über den Nutzer verwendet.
                  • phone_number (string) – Telefonnummer für die passwortlose Authentifizierung.
                  • code (string) – Bestätigungscode, der per SMS versendet wird.
                  • operation_id (string) – Individuelle Kennung, die zur Bestätigung der Benutzer-Telefonnummer während einer laufenden Sitzung verwendet wird.
                  • isOauth2 (boolean) – Ob die auf dem OAuth 2.0-Protokoll basierende Authentifizierung für Benutzer verwendet werden soll. Erforderlich.

                  Beispiel:

                  Copy
                  Full screen
                  Small screen
                    let result
                    // Request
                    api.loginWithPhoneCode({
                      phone_number: 'email@address.com',
                      code: '3423',
                      operation_id: '334j255fdf13d515fgd1',
                      isOauth2: true
                    }).then((res) => {
                      result = res;
                    })
                    
                    // Response
                    result === {
                      login_url: 'https://someurl.com?token=XXXXXXX'
                    }
                    
                    
                    // Response with additional fields
                    result === {
                      ask_fields: [{
                        confirmation_type: 'code' || 'link'
                        name: 'email'
                        required: false
                        step: 0 // Displays the position of the field in the data retrieval queue.
                        type: 'email'
                        validation: {} // Custom validation
                      }]
                      login_url: 'https://someurl.com?token=XXXXXXX',
                      token: 'sometoken'
                    }

                    AufrufBeschreibungParameter
                    api.loginWithEmailCode({ email, code, operation_id, isOauth2 });Bestätigt die E-Mail-Adresse. Als Antwort erhält man die URL mit dem Parameter token. Dieser wird bei der Abfrage zusätzlicher Daten über den Nutzer verwendet.
                    • email (string) – E-Mail-Adresse für die passwortlose Authentifizierung.
                    • code (string) – der per E-Mail versendete Bestätigungscode.
                    • operation_id (string) – Individuelle Kennung, die zur Bestätigung der E-Mail-Adresse während einer laufenden Sitzung verwendet wird.
                    • isOauth2 (boolean) – Ob die auf dem OAuth 2.0-Protokoll basierende Authentifizierung für Benutzer verwendet werden soll. Erforderlich.

                    Beispiel:

                    Copy
                    Full screen
                    Small screen
                      let result
                      // Request
                      api.loginWithEmailCode({
                        email: 'email@address.com',
                        code: '3423',
                        operation_id: '334j255fdf13d515fgd1',
                        isOauth2: true
                      }).then((res) => {
                        result = res;
                      })
                      
                      // Response
                      result === {
                        login_url: 'https://someurl.com?token=XXXXXXX'
                      }
                      
                      // Response with additional fields
                      result === {
                        ask_fields: [{
                          confirmation_type: 'code' || 'link'
                          name: 'phone_number'
                          required: false
                          step: 0 // Displays the position of the field in the data retrieval queue.
                          type: 'phone'
                          validation: {} // Custom validation
                        }]
                        login_url: 'https://someurl.com?token=XXXXXXX',
                        token: 'sometoken'
                      }

                      Felder für zusätzliche Abfragen ohne Passwort

                      Ablauf für den Nutzer:

                      1. Nach erfolgreicher Authentifizierung eines Benutzers erhält man als Antwort auf den Aufruf api.loginWithEmailCode oder api.loginWithPhoneCode ein Array von Feldern, die in einer App in einem separaten Formular angezeigt werden können und mit denen sich zusätzlich die Telefonnummer und die E-Mail-Adresse des Benutzers erfassen lassen. Die Liste der Felder lässt sich ebenfalls über den Aufruf api.getAskFields abrufen.
                      2. Der Benutzer gibt seine Telefonnummer oder E-Mail-Adresse ein. Anschließend wird der api.ask-Aufruf ausgeführt.
                      3. Der Server empfängt die Daten und sendet einen Bestätigungscode an eine Telefonnummer oder E-Mail-Adresse. Wird beim Initialisieren des Codes der Parameter disableConfirmByLink=true (deaktiviert die Anmeldebestätigung über den Link in der E-Mail) übermittelt, wird für die automatische Weiterleitung des Benutzers nach dem Anklicken des Links der Aufruf api.getConfirmCode verwendet.
                      4. Als Antwort auf den Aufruf api.ask erhält man den Parameter operation_id, mit dem sich die Telefonnummer bzw. die E-Mail-Adresse durch den Aufruf api.loginWithPhoneCode bzw. api.loginWithEmailCode bestätigen lässt.
                      5. Nach erfolgreicher Datenbestätigung erhält man als Antwort die URL, an die ein authentifizierter Benutzer weitergeleitet wird.

                      AufrufBeschreibungParameter
                      api.getAskFields(token);Ruft die Liste der Felder für weitere Abfragen ab.
                      • token (string) – Benutzer-JWT. Erforderlich.

                      Beispiel:

                      Copy
                      Full screen
                      Small screen
                        let result
                        // Request
                        api.getAskFields({
                          token: 'sometoken'
                        }).then((res) => {
                          result = res;
                        })
                        
                        // Response
                        result === [
                          {
                            confirmation_type: 'code' || 'link'
                            name: 'phone_number' || 'email'
                            required: false
                            step: 0 // Displays the position of the field in the data retrieval queue.
                            type: 'phone' || 'email'
                            validation: {} // Custom validation
                          }
                        ]

                        AufrufBeschreibungParameter
                        api.ask({ fields, token, link_url });Sendet zusätzliche Daten (Telefonnummer oder E-Mail-Adresse) über den Benutzer. Der zur Bestätigung der angegebenen Telefonnummer oder E-Mail-Adresse genutzte operation_id-Parameter wird in der Antwort zurückgegeben. Wenn keine Bestätigung erforderlich ist, wird in der Antwort die URL mit dem token-Parameter zurückgegeben, an die ein authentifizierter Benutzer weitergeleitet wird.
                        • fields (object) – Objekt, in dem die Telefonnummer oder E-Mail-Adresse des Benutzers übermittelt wird. Erforderlich.
                        • token (string) – Benutzer-JWT. Erforderlich.
                        • link_url (string) – Bestätigungs-URL.

                        Beispiel für das Senden einer Telefonnummer:

                        Copy
                        Full screen
                        Small screen
                          let result
                          // Request
                          api.ask({
                            fields: {  
                              phone_number: '+somenumber'
                            },
                            link_url: 'https://someurl.com',
                            token: 'sometoken'
                          }).then((res) => {
                            result = res;
                          })
                          
                          // Response
                          result === {
                            error: {
                              code: '003-014'
                              description: 'Confirm phone number.'
                              details: { operation_id: 'BPaBScLM44GesoOYSxT5I8QfgIrTSURd' }
                            }
                          }
                          
                          // Response without confirmation
                          result === {
                            redirect_url: '<login_url>?token=<token>'
                          }

                          Beispiel für das Senden einer E-Mail-Adresse:

                          Copy
                          Full screen
                          Small screen
                            let result
                            // request
                            api.ask({
                              fields: {  
                                email: 'email@address.com'
                              },
                              link_url: 'https://someurl.com',
                              token: 'sometoken'
                            }).then((res) => {
                              result = res;
                            })
                            
                            // Response
                            result === {
                              error: {
                                code: '003-011'
                                description: 'Confirm email.'
                                details: { operation_id: 'BPaBScLM44GesoOYSxT5I8QfgIrTSURd' }
                              }
                            }
                            
                            // Response without confirmation
                            result === {
                              redirect_url: '<login_url>?token=<token>'
                            }

                            AufrufBeschreibungParameter
                            api.getConfirmCode({ cancelToken, login, operation_id });Ruft den Bestätigungscode ab, um den Benutzer nach Klick auf den Link automatisch weiterzuleiten.
                            • cancelToken (string) – Individueller Token zum Beenden der Sitzung. Erforderlich.
                            • login (string) – Telefonnummer oder E-Mail-Adresse des Benutzers. Erforderlich.
                            • operation_id (string) – Individuelle Kennung, die zur Bestätigung einer Telefonnummer oder E-Mail-Adresse eines Benutzers während einer laufenden Sitzung verwendet wird. Erforderlich.

                            Beispiel:

                            Copy
                            Full screen
                            Small screen
                              let result
                              // Request
                              const axiosCancelToken = Axios.CancelToken.source();
                              
                              api.getConfirmCode({
                                cancelToken: axiosCancelToken,
                                login: '+somenumber' || 'email@address.com',
                                operation_id: '334j255fdf13d515fgd1'
                              }).then((res) => {
                                result = res;
                              })
                              
                              // Response
                              result === {
                                code: 'string'
                              }
                              
                              // If the waiting time has elapsed, returns:
                              result === {
                                error: {
                                  code: '010-050',
                                  description: 'Deadline exceeded.'
                                }
                              }
                              
                              // If you no longer need to wait for verification through the link you can close the request waiting period:
                              axiosCancelToken.cancel();

                              AufrufBeschreibungParameter
                              api.loginWithPhoneCode({ phone_number, code, operation_id, isOauth2 });Bestätigt die Telefonnummer. Als Antwort erhält man die URL mit dem Parameter token. Dieser wird bei der Abfrage zusätzlicher Daten über den Nutzer verwendet.
                              • phone_number (string) – Telefonnummer für die passwortlose Authentifizierung.
                              • code (string) – Der per SMS versendete Bestätigungscode.
                              • operation_id (string) – Individuelle Kennung, die zur Bestätigung der Benutzer-Telefonnummer während einer laufenden Sitzung verwendet wird.
                              • isOauth2 (boolean) – Ob die auf dem OAuth 2.0-Protokoll basierende Authentifizierung für Benutzer verwendet werden soll. Erforderlich.

                              Beispiel:

                              Copy
                              Full screen
                              Small screen
                                let result
                                // Request
                                api.loginWithPhoneCode({
                                  phone_number: 'email@address.com',
                                  code: '3423',
                                  operation_id: '334j255fdf13d515fgd1',
                                  isOauth2: true
                                }).then((res) => {
                                  result = res;
                                })
                                
                                // Response
                                result === {
                                  login_url: 'https://someurl.com?token=XXXXXXX'
                                }
                                
                                
                                // Response with additional fields
                                result === {
                                  ask_fields: [{
                                    confirmation_type: 'code' || 'link'
                                    name: 'email'
                                    required: false
                                    step: 0 // Displays the position of the field in the data retrieval queue.
                                    type: 'email'
                                    validation: {} // Custom validation
                                  }]
                                  login_url: 'https://someurl.com?token=XXXXXXX',
                                  token: 'sometoken'
                                }

                                AufrufBeschreibungParameter
                                api.loginWithEmailCode({ email, code, operation_id, isOauth2 });Bestätigt die E-Mail-Adresse. Als Antwort erhält man die URL mit dem Parameter token. Dieser wird bei der Abfrage zusätzlicher Daten über den Nutzer verwendet.
                                • email (string) – E-Mail-Adresse für die passwortlose Authentifizierung.
                                • code (string) – Der an die E-Mail-Adresse gesendete Bestätigungscode.
                                • operation_id (string) – Individuelle Kennung, die zur Bestätigung der E-Mail-Adresse eines Benutzers während einer laufenden Sitzung verwendet wird.
                                • isOauth2 (boolean) – Ob die auf dem OAuth 2.0-Protokoll basierende Authentifizierung für Benutzer verwendet werden soll. Erforderlich.

                                Beispiel:

                                Copy
                                Full screen
                                Small screen
                                  let result
                                  // Request
                                  api.loginWithEmailCode({
                                    email: 'email@address.com',
                                    code: '3423',
                                    operation_id: '334j255fdf13d515fgd1',
                                    isOauth2: true
                                  }).then((res) => {
                                    result = res;
                                  })
                                  
                                  // Response
                                  result === {
                                    login_url: 'https://someurl.com?token=XXXXXXX'
                                  }
                                  
                                  // Response with additional fields
                                  result === {
                                    ask_fields: [{
                                      confirmation_type: 'code' || 'link'
                                      name: 'phone_number'
                                      required: false
                                      step: 0 // Displays the position of the field in the data retrieval queue.
                                      type: 'phone'
                                      validation: {} // Custom validation
                                    }]
                                    login_url: 'https://someurl.com?token=XXXXXXX',
                                    token: 'sometoken'
                                  }

                                  Zurücksetzen von Passwörtern

                                  Ablauf für den Nutzer:

                                  1. Die Anwendung öffnet ein Formular, in das der Benutzer seine E-Mail-Adresse oder seinen Benutzernamen eingibt. Anschließend wird der api.reset-Aufruf ausgeführt.
                                  2. Der Server sendet eine Bestätigung per E-Mail an den Benutzer.
                                  3. Der Benutzer klickt auf den Link in der E-Mail, woraufhin sich ein Formular öffnet.
                                  4. Dort gibt der Benutzer ein neues Passwort ein. Anschließend wird der api.set-Aufruf ausgeführt.

                                  AufrufBeschreibungParameter
                                  api.reset(username);Setzt das Passwort zurück und bestätigt die Aktion. Um das Zurücksetzen des Passworts zu bestätigen, muss der Benutzer auf den Link in der E-Mail klicken. Der Benutzername oder die E-Mail-Adresse des Benutzers wird im username-Objekt übermittelt. Als Antwort wird der Code 204 zurückgegeben.
                                  • username (string) – Benutzername, z. B.: John, oder eine E-Mail-Adresse, z. B.: email@address.com. Erforderlich.

                                  Beispiel:

                                  Copy
                                  Full screen
                                  Small screen
                                    let result
                                    // Request
                                    api.reset({
                                      username: 'John'
                                    }).then((res) => {
                                      res.code === 204;
                                    })

                                    AufrufBeschreibungParameter
                                    api.set({ new_password, reset_code, user_id });Legt ein neues Passwort fest und bestätigt die Aktion. Um ein neues Passwort zu bestätigen, muss der Benutzer auf den Link in der E-Mail klicken. Als Antwort wird der Code 204 zurückgegeben.
                                    • new_password (string) – Ein vom Benutzer eingegebenes neues Passwort. Erforderlich.
                                    • reset_code (string) – Ein Code für die Verifikation eines Benutzers, der eine Anfrage zum Zurücksetzen seines Passworts gesendet hat. Der Code wird serverseitig generiert und in der URL übermittelt, zu der der Benutzer nach Klick auf den Link in der E-Mail weitergeleitet wird. Erforderlich.
                                    • user_id (string) – Benutzerkennung. Wird serverseitig generiert und in der URL übermittelt, zu der der Benutzer nach Klick auf den Link in der E-Mail weitergeleitet wird. Erforderlich.

                                    Beispiel:

                                    Copy
                                    Full screen
                                    Small screen
                                      let result
                                      // Request
                                      api.set({
                                        new_password: 'newpass',
                                        reset_code: '3423',
                                        user_id: '324324234'
                                      }).then((res) => {
                                        res.code === 204;
                                      })

                                      Single Sign-On

                                      Hinweis
                                      Ausführliche Informationen finden Sie in der Anleitung über den Single Sign-On.
                                      ParameterTypBeschreibung
                                      api.checkUserAuthSSO();
                                      Prüft, ob ein Benutzer über Single Sign-On autorisiert ist. Wenn dem so ist, wird ein Einmalcode (code) zurückgegeben.

                                      Beispiel:

                                      Copy
                                      Full screen
                                      Small screen
                                        let result
                                        // Request
                                        api
                                          .checkUserAuthSSO()
                                          .then(res => {
                                            result === res;
                                          });
                                        
                                        result === {
                                          code: "examplecode"
                                        }

                                        AufrufBeschreibungParameter
                                        api.userAuthSSOWithRedirect(loginUrl);Prüft, ob ein Benutzer über Single Sign-On autorisiert wurde. Wenn dem so ist, wird der Benutzer zur URL weitergeleitet; die generierte loginUrl enthält einen Autorisierungscode.
                                        • loginUrl (string) – URL, an die ein Benutzer nach einer SSO-Prüfung weitergeleitet wird. Muss mit der Rückruf-URL übereinstimmen, die im Kundenportal unter Ihr Login-Projekt > Allgemeine Einstellungen im Block URL angegeben ist. Erforderlich, wenn es mehrere URL-Adressen gibt, an die ein Benutzer weitergeleitet werden kann.

                                        Beispiel:

                                        Copy
                                        Full screen
                                        Small screen
                                          // Request
                                          api
                                            .userAuthSSOWithRedirect(
                                              loginUrl: 'some-redirect-url.com'
                                            )
                                            .then(res => {
                                              res.code === 302;
                                            });

                                          AufrufBeschreibungParameter
                                          api.logout(token, session);Meldet einen Benutzer aus dem System ab und löscht eine Benutzersitzung entsprechend dem Parameter session.
                                          • token (string) – Benutzer-JWT. Erforderlich.
                                          • session (string) – zeigt, wie sich ein Benutzer aus dem System abmeldet und wie seine Sitzung gelöscht wird. Erforderlich. Möglich sind:
                                            • sso — löscht nur die SSO-Benutzersitzung.
                                            • all — löscht die SSO-Benutzersitzung und alle Zugriffstoken sowie Aktualisierungen.

                                          Beispiel:

                                          Copy
                                          Full screen
                                          Small screen
                                            // Request
                                            api
                                              .logout(
                                                token: 'exampleToken',
                                                session: 'sso' | 'all'
                                              )
                                              .then(res => {
                                                res.code === 204;
                                              });

                                            War dieser Artikel hilfreich?
                                            Vielen Dank!
                                            Gibt es etwas, das wir verbessern können? Nachricht
                                            Das tut uns leid
                                            Bitte erläutern Sie, weshalb dieser Artikel nicht hilfreich ist. Nachricht
                                            Vielen Dank für Ihr Feedback!
                                            Wir werden Ihr Feedback aufgreifen und dazu nutzen, Ihr Erlebnis verbessern.
                                            Diese Seite bewerten
                                            Diese Seite bewerten
                                            Gibt es etwas, das wir verbessern können?

                                            Jetzt nicht

                                            Vielen Dank für Ihr Feedback!
                                            Letztmalig aktualisiert: 8. August 2022

                                            Haben Sie einen Tippfehler oder einen anderen Textfehler gefunden? Wählen Sie den Text aus und drücken Sie Strg+Eingabe.

                                            Problem melden
                                            Wir überprüfen unsere Inhalte ständig. Ihr Feedback hilft uns, sie zu verbessern.
                                            Geben Sie eine E-Mail-Adresse an, damit wir Sie erreichen können
                                            Vielen Dank für Ihr Feedback!