REST API 会員API
最終更新日 2016-4-21

会員を更新する

会員を更新します

基本仕様

ユーザIDで指定される会員情報を更新します。

ただし、SNS 連携会員を更新する場合は、このエンドポイントではなく、
「会員を登録する (または SNS 会員の更新)」 を利用いただく必要がありますので
この点によくご注意下さい。

ユーザIDは登録するログインするのレスポンスより取得できます。

コントロールパネルの会員管理 / 基本設定にて、メールアドレス認証を設定するに設定の場合、
メールアドレス更新時にメールアドレス認証用の確認メールを送信します。

HTTPメソッド

PATCH または POST(*1)

(*1) 〜 POSTを利用する場合、クエリにてproc=patchを指定してください。

エンドポイント

/v1/usr/{データストアID}/{アプリID}/{ユーザID}

リクエスト

トークンには ストアトークンを指定します。指定箇所はヘッダX-APPIARIES-TOKENまたはクエリaccess_tokenに指定します。

ヘッダ

キー 必須 説明 備考
X-APPIARIES-TOKEN △(*2) ストアトークンを指定ください。
Content-Type application/json

クエリ

キー名 必須 説明
access_token △(*2) ストアトークンを指定ください。
proc △(*3) 指定する場合はPATCH固定。
get 共通仕様参照

(*2) 〜 ヘッダX-APPIARIES-TOKENまたはクエリaccess_tokenでいずれか指定します。また、ストアトークンは会員管理のログインするでログイン成功時に取得することができます。

(*3) 〜 メソッドPOSTを利用の場合は必須。

コンテント

キー名 必須 説明 データ型 備考
pw パスワード。パスワードを更新したい場合に指定します。 String (*6)
email メールアドレス。メールアドレスを更新したい場合に指定します。確認メールが送信されます。 String (*4)(*6)
任意キー 任意の会員属性 String / Number / Boolean (*5)(*7)

(*4) ~ emailを指定する場合は、メールアドレス認証用の確認メールが送信されます。

(*5) ~ 任意キーは予約語(共通仕様参照)を除くキーを任意で指定できます。

(*6) ~ SNS連携による更新の場合は、pw および email を指定することはできません。

(*7) ~ SNS連携による更新の場合は、任意キーに対して login_idpwemail, email_verified を指定することはできません。

成功時レスポンス

リクエスト成功時のレスポンスに関して記述します。エラー時のレスポンスに関しては、共通エラーレスポンス を参照ください。

ヘッダ

キー名 説明
Content-Type application/json

HTTPステータス

ステータスコード 説明
200 更新完了。メールアドレス認証設定するまたはget=trueが指定された場合。(*8)
204 更新完了

(*8) ~ メールアドレス認証が設定するに設定されている場合、emailを更新した場合のステータスコード。メールアドレス確認用メールが送信されます。

コンテント

メールアドレス更新時のみステータスコード200と共に返却されます。(204の場合はコンテント無し。)

キー名 説明 データ型 備考
任意キー 任意の会員属性 String / Number / Boolean (*9)
_email_token テンポラリトークン(メールアドレス検証用) String (*10)

(*9) ~ リクエストクエリget=trueとした場合のみ返却されます。

(*10) ~ コントロールパネルにてメールアドレス認証を設定するとした場合のみ返却されます。

エラーレスポンス

エラー発生時のレスポンスは、共通仕様の共通エラーレスポンスを参照。