サーバー構築不要！スマートフォンアプリ向けの新クラウド

トップ >ドキュメント >REST API リファレンス:会員検索

REST API リファレンス

共通ドキュメント

会員検索

会員検索APIについて

クエリ条件に合致した会員のうち、読み込み権限がある会員の情報の取得を行います。
クエリ条件を指定しない場合は全件取得となります。
※値が設定されている項目のみ返却されます。
※limitを指定していない場合、検索結果として取得される最大データ件数は100件です。
検索結果のデータ件数が多い場合は、limitとskipを活用してください。
※デフォルトの権限では、会員データは本人のみデータの読み込みや更新が可能となっています。

基本仕様

  • APIパス
    • 全件検索：/users
    • 指定検索：/users?where=
  • メソッド：GET

リクエストヘッダー

シグネチャやAPIキーなどの詳細は「共通フォーマット」を参照してください。

フィールド名 内容
Content-Type application/json

リクエストコンテント

パラメータ名 説明 データ型 必須 バリデーション
objectId オブジェクトID 文字列
userName 会員名 文字列
mailAddressConfirm メールアドレス確認状態 真偽値
mailAddress メールアドレス 文字列
createDate 登録日時 日付
updateDate 更新日時 日付
- 追加フィールド -

HTTPステータス

ステータスコード 説明
200 検索完了

レスポンスヘッダー

フィールド名 値
Content-Type application/json

レスポンスコンテント

{"results":[{(オブジェクト情報1)},{(オブジェクト情報2)},{}…]}の配列が返却されます。
以下、オブジェクト情報を記載しています。

パラメータ名 説明 データ型 備考
objectId オブジェクトID 文字列
userName 会員名 文字列
authData OAuth認証情報 配列 会員管理のデータ取得時にSNS認証データを含める設定を行っている場合のみOAuth認証情報を返却します。
mailAddressConfirm メールアドレス確認状態 真偽値
mailAddress メールアドレス 文字列
createDate 登録日時 日付
updateDate 更新日時 日付
acl ACL 一対一オブジェクト

リクエストサンプル

curl -X GET -G \
 -H "X-NCMB-Application-Key:549116a86b0ebbec4832d4086a56f36c82a5d64bc6528fa5e6220be76db5ef45" \
 -H "X-NCMB-Timestamp:2013-09-10T02:44:35.452Z" \
 -H "X-NCMB-Signature: jm9/IFJr0BZIU0WSGMHxT/ldHMSD28B4gqkGIEKqkC8=" \
 -H "Content-Type: application/json" \
 --data-urlencode 'where={"userName":"yamada"}' \
 https://mbaas.api.nifcloud.com/2013-09-01/users

レスポンスサンプル

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "results":[
    {
      "objectId":"WJEWWh9dPXtWuBzA",
      "userName":"yamada",
      "authData":null,
      "mailAddress":null,
      "mailAddressConfirm":null,
      "createDate":"2013-09-11T11:44:56.700Z",
      "updateDate":"2013-10-04T05:39:07.408Z",
      "acl":{
        "WJEWWh9dPXtWuBzA":{
          "read":true,
          "write":true
        },
        "*":{
          "read":true,
          "write":true
        }
      }
    }
  ]
}

お探しの内容が見つからなかった場合はユーザーコミュニティ もご活用ください。（回答保証はいたしかねます）
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。

推奨画面サイズ1024×768px以上

ページの先頭へ