APIリファレンス(JavaScript)

baasatrakuza > UserClient

UserClient class

ユーザー管理APIのClientです。

Signature:

export declare class UserClient extends ClientBase 

Extends: ClientBase

Remarks

ユーザー情報を操作するためのメソッドを提供します。

Methods

MethodModifiersDescription
auth(loginId, password)ログイン情報でのユーザー認証を行います。
authWithLine(token)LINEのIDトークンでユーザー認証を行います。
authWithModelChangeCode(modelChangeCode, password)機種変更認証コードの認証を行います。
beginTokenUpdate(userAccessToken)新しいユーザーアクセストークンを仮発行します。
clearPushDeviceToken(userAccessToken)Pushデバイストークンをクリアします。
commitMailAddressVerification(userAccessToken, uriParam, checkOnly)(BETA) メールアドレスの検証を確定します。
commitTokenUpdate(userAccessToken)新しいユーザーアクセストークンを確定します。
createEditOp(user)ユーザー情報を編集する操作を生成します。
createGetOp()ユーザー情報を取得する操作を生成します。
createRegisterOp(user)ユーザー情報を登録する操作を生成します。
createRegisterWithLineOp(user, token)ユーザー情報の登録とLINEのIDトークンをもとにLINEIDの連携を行う操作を生成します。
delete(userAccessToken)ユーザー情報を削除します。
edit(user)ユーザー情報を編集します。
editPassword(userAccessToken, nowPassword, newPassword)パスワードを編集します。
fields(visibleOnly)BaaS@rakuzaに設定されているユーザーの項目定義情報を取得します。
fromJSON(json)JSONから、Userを生成して返します。
get(userAccessToken)ユーザー情報を取得します。
issueModelChangeCode(userAccessToken, param)機種変更登録情報を指定して、機種変更認証コードの発行を行います。
linkToLine(userAccessToken, token)LINEのIDトークンでLINEIDの連携を行います。
register(user)ユーザー情報を登録します。
registerPushDeviceToken(userAccessToken, deviceToken, deviceType)Pushデバイストークンを登録します。
registerWithLine(user, token)ユーザー情報の登録とLINEのIDトークンをもとにLINEIDの連携を行います。
unlinkFromLine(userAccessToken)LINEIDの連携を解除します。
updateToken(userAccessToken)ユーザーアクセストークンを更新します。