ユーザー情報更新API
認証トークンを使用して、ユーザーアカウント情報を更新します。
メールアドレスやパスワードを更新することで、アカウント情報を最新に保ち、セキュリティを強化できます。
このAPIはパーソナルプラン以上で利用できます。
/api/user/v1/update
X-Access-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...{
"eml": "yourchange@gmail.com",
"pwd": "Zght943!"
}Request Parameters
- eml string
-
変更するメールアドレス。
メールアドレス変更後、ログイン時に再認証が必要です。 - pwd string
-
変更するパスワード。
6～30文字の英字と数字を組み合わせて入力してください。
{
"code": 0,
"message": "",
"result": null
}Response Parameters
- code integer
- 応答コード: 0 = 成功、それ以外の値 = エラー
- message string
- 応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
- result null
このAPIを利用する場面
ユーザーが連携しているメールアドレスを変更する場合や、セキュリティ上の理由でパスワードを再設定する必要がある場合に使用します。
特に、企業向け環境での定期的なパスワード変更ポリシーの適用や、ユーザー情報の同期を伴うワークフローの自動化において重要なAPIです。
メール変更時の注意事項
メールアドレスの変更は単なる情報更新ではありません。
変更後は新しいメールアドレスで再認証が必要となり、新しいトークンの発行も必要です。
メール変更を自動化する場合、変更直後に旧トークンでAPIを呼び出すと認証エラーが発生する可能性があります。
メール変更後は必ず認証APIを再度呼び出し、新しいトークンを取得してから後続処理を実行してください。
パスワードポリシー
pwdは6〜30文字の英字と数字を組み合わせて入力する必要があります。
この条件を満たさない場合、リクエストは拒否されます。
自動化環境でパスワードを変更する場合は、安全に管理し、平文で保存しないようにしてください。
運用上の重要ポイント
このAPIは単なるデータ更新ではなく、アカウントのセキュリティ状態を変更する重要なAPIです。
メールアドレスやパスワードの変更はログイン情報や認証フローに直接影響し、 セッションの無効化、再認証の要求、セキュリティ通知などの後続処理が必要になる場合があります。
利用時の注意点
メールアドレスの変更はアカウントの所有権に直結するため、慎重に行う必要があります。
- パスワードは必ず安全な通信（HTTPS）で送信してください。
- クライアントから直接APIを呼び出す方式は、セキュリティリスクとなる可能性があります。
- 変更後はトークンを直ちに無効化することを推奨します。
- 入力値の検証は必ずサーバー側で実施してください。