REST.Backend.EMSServices.TEMSLoginAPI.SignupUser

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

procedure SignupUser(const AUserName, APassword: string;
const AUserData: TJSONObject; out ACreatedObject: TBackendEntityValue);

C++

void __fastcall SignupUser(const System::UnicodeString AUserName, const System::UnicodeString APassword, System::Json::TJSONObject* const AUserData, /* out */ Rest::Backend::Metatypes::TBackendEntityValue &ACreatedObject);

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
procedure
function
protected
REST.Backend.EMSServices.pas
REST.Backend.EMSServices.hpp
REST.Backend.EMSServices TEMSLoginAPI


Beschreibung

Registriert ein Benutzerkonto auf dem EMS-Server mit dem angegebenen Benutzernamen und Passwort und führt die Anmeldung beim EMS-Server durch, um Authentifizierungsdaten für weitere Anforderungen abzurufen.

SignupUser übernimmt die folgenden Parameter:

  • AUserName ist der zu registrierende Benutzername.
  • APassword ist das für diesen Benutzernamen zu registrierende Passwort.
  • AUserData ist ein optionales JSON-Objekt mit Schlüssel/Wertepaaren der Benutzerdaten, die an den EMS-Server zusammen mit dem angegebenen Benutzernamen und Passwort gesendet werden sollen. Verwenden Sie einen nil-Wert als Parameter, wenn Sie keine zusätzlichen Benutzerdaten angeben.
  • ACreatedObject ist eine Instanz von TBackendEntityValue, die SignupUser mit den vom EMS-Server gesendeten Authentifizierungsdaten füllt.

Exceptions

Exception Meldung Beschreibung

EEMSClientAPIError

MasterSecret erforderlich

Der Authentifizierungstyp ist TAuthentication.MasterSecret, und die Eigenschaft MasterSecret der Verbindungsinformationen des zugrunde liegenden EMS-Backend-Dienstes ist ein leerer String.

Sitzungs-Token erwartet

Die Antwort vom EMS-Server enthält kein Sitzungs-Token.

Die Antwort vom EMS-Server muss ein JSON-Objekt der Anmeldedaten sein, das ein Schlüssel/Wertepaar mit dem Wert von TJSONNames.SessionToken als Schlüssel enthält.

Sitzungs-Token erforderlich

Der Authentifizierungstyp ist TAuthentication.Session, und Sie haben sich nicht angemeldet.

Siehe auch