REST API リファレンス
- ドキュメントトップ
-
共通
-
プッシュ通知
-
会員管理・認証
-
データストア
-
ファイルストア
-
スクリプト
共通ドキュメント
会員更新
Contents |
会員更新APIについて
指定した会員情報の更新を行います。
管理画面の会員認証設定にて、メールによる会員認証を許可している場合、
メールアドレスの更新時に確認用メールを送信します。
基本仕様
- APIパス:/users/オブジェクトID
- メソッド:PUT
リクエスト
ヘッダー
シグネチャやAPIキーなどの詳細は「共通フォーマット」を参照してください。
フィールド名 | 内容 |
---|---|
Content-Type | application/json |
コンテント
パラメータ名 | 説明 | データ型 | 必須 | バリデーション |
---|---|---|---|---|
userName | 会員名 | 文字列 | 一意チェック 整合性チェック 使用不可文字列チェック(※1) |
|
authData | OAuth認証情報 | 一対一オブジェクト | フォーマットチェック(※2) 整合性チェック |
|
mailAddress | メールアドレス | 文字列 | 一意チェック フォーマットチェック |
|
acl | ACL | 一対一オブジェクト | ||
- | 追加フィールド | - | フィールド名のフォーマットチェック (半角英数+「_」のみ) |
会員名はアプリケーションごとに一意になっている必要があります。
※1:会員名には、null・空文字列・空白文字のみの入力は使用できません。
OAuth認証情報を削除する場合は「NULL」を指定します。
(例)Facebookの認証情報を削除する場合:
"authData": {
"facebook": null
}
※2:認証情報は、指定がされたもののみ、更新・削除対象になります。
メールアドレスはアプリケーションごとに一意になっている必要があります。
追加フィールドは対象となるクラス/フィールドに依存しており、複数存在する場合もあります。
フィールド名に「_id」は指定不可とします。
レスポンス
HTTPステータス
ステータスコード | 説明 |
---|---|
200 | 更新完了 |
ヘッダー
フィールド名 | 値 |
---|---|
Content-Type | application/json |
コンテント
パラメータ名 | 説明 | データ型 | 備考 |
---|---|---|---|
updateDate | 更新日時 | 日付 |
リクエストサンプル
curl -X PUT \
-H "X-NCMB-Apps-Session-Token:46MnVgUbwHIXIHp9mowIeh7r2" \
-H "X-NCMB-Application-Key: 549116a86b0ebbec4832d4086a56f36c82a5d64bc6528fa5e6220be76db5ef45" \
-H "X-NCMB-Timestamp: 2013-08-14T15:46:25.543" \
-H "X-NCMB-Signature: WRAfDyz9ijqeUEBEETv57dzb+OzwAeaVSnfG9ez/BYI=" \
-H "Content-Type: application/json" \
-d '{"mailAddress": "mobilebackend@example.com"}' \
https://mbaas.api.nifcloud.com/2013-09-01/users/epaKcaYZqsREdSMY
レスポンスサンプル
HTTP/1.1 200 OK
{"updateDate":"2013-08-28T12:21:17.087Z"}
お探しの内容が見つからなかった場合はユーザーコミュニティ
もご活用ください。(回答保証はいたしかねます)
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。
推奨画面サイズ1024×768px以上