PUT User Info 解説

ユーザー情報を登録・更新・削除します

概要

リクエストされた認証トークンを用いてユーザー認証を行い、成功した場合、対象ユーザーのデータを更新する
更新に成功した場合は、レスポンスコード「200」として、レスポンスを返す。
更新に失敗した場合は、レスポンスコード「400」として、レスポンスを返す。

エンドポイント

https://z3k5i60syl.execute-api.ap-northeast-1.amazonaws.com/PUTUserInfo

メソッド

PUT

接続先

DynamoDB

リクエストヘッダー

フィールド名
Content-Typeapplication/json
AuthorizationPOST User Auth で取得したuserTokenId

リクエストデータ

JSON Key必須値の説明
tenantIdString[WHERE]DBカラム:users.tenantId
genderStringmale,female,unknownのいずれか
areaString[UPDATE]DBカラム:users.area
dateOfBirthString[UPDATE]DBカラム:users.dateOfBirth

処理結果ステータス

ステータスメッセージ
200OK
400BAD REQUEST
500INTERNAL SERVER ERROR

動作例

GET User Info で現在のユーザー情報を取得すると、"gender"、"area"、"dateOfBirht"が空欄("")になっています。

ユーザー情報確認

認証方式に Bearer Token を選択して POST User Auth で取得した Token をヘッダにつける。
Body部分にJSON形式で更新したい項目を追加してPUTリスエストを送信。ここでは、"gender" に "male"、"area" に "東京"、"dateOfBirht" に "1995-01-01" をPUTします。

ユーザー情報更新

GET User Info で更新後のユーザー情報を取得すると、"gender"、"area"、"dateOfBirht" がそれぞれ "male"、"東京"、"1995-01-01" になっています。

認証失敗

概要

Q: 登録したユーザーを削除する事は可能でしょうか。
A: 現在、削除用のインターフェースは用意しておりません。 基本的に、ユーザーの管理はAPI側のみに依存する仕様の想定ではなく、 実際のサービス提供側のシステム内で管理することを想定しています。 その中で削除なのか停止をしていただき、こちら側の仕組みとしましては残存することになります。

戻る