REST.Backend.EMSApi.TEMSClientAPI.SignupUser
Delphi
procedure SignupUser(const AUserName, APassword: string; const AUserFields: TJSONObject; out ALogin: TLogin);
C++
void __fastcall SignupUser(const System::UnicodeString AUserName, const System::UnicodeString APassword, System::Json::TJSONObject* const AUserFields, /* out */ TLogin &ALogin);
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
procedure function |
public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
指定されたユーザー名とパスワードで EMS サーバーにユーザー アカウントを登録し、EMS サーバーにログインして、それ以降の要求で使用できる認証データを取得します。
SignupUser が受け取るパラメータは次のとおりです。
AUserName
: 登録するユーザー名です。APassword
: そのユーザー名用に登録するパスワードです。AUserFields
(任意指定): 指定されたユーザー名およびパスワードと共に EMS サーバーに送信するユーザー データのキー/値ペアを格納した JSON オブジェクトです。付加的なユーザー データを渡さない場合は、このパラメータに nil 値を使用します。ALogin
: EMS サーバーから送信される認証データの格納先として SignupUser メソッドで使用される TLogin インスタンスです。
例外
例外 | メッセージ | 説明 |
---|---|---|
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
セッション トークンが必要です |
EMS サーバーからの応答にセッション トークンが含まれていません。 EMS サーバーからの応答は、TJSONNames.SessionToken の値をキーとするキー/値ペアが格納されたユーザー登録データの JSON オブジェクトでなければなりません。 | |
セッション トークンが必要です |
Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 |
関連項目
- REST.Backend.EMSApi.TEMSClientAPI.AddUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveCurrentUser
- REST.Backend.EMSApi.TEMSClientAPI.UpdateUser
- REST.Backend.EMSApi.TEMSClientAPI.QueryUserName
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersNames
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersFields
- REST.Backend.EMSApi.TEMSClientAPI.QueryUsers
- REST.Backend.EMSApi.TEMSClientAPI.LoginUser
- REST.Backend.EMSApi.TEMSClientAPI.LogoutUser
- REST.Backend.EMSApi.TEMSClientAPI.DeleteUser