QuickBlox Developers (API docs, code samples, SDK)

From QuickBlox Developers (API docs, code samples, SDK)

Revision as of 10:36, 9 May 2012 by Yulia.sidorenko (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Jump to: navigation, search

Summary

The user module manages all things related to user accounts handling, authentication, account data, password reminding etc.

OAuth is secure and supports transparent authentication;
Password reminder and other typical user management tasks are managed automatically. Reminders and other technical messages are sent via Messages module;
Account Integration with Facebook, Twitter, Google, OpenID and others is supported via OAuth – logging in users with their Facebook/Twitter accounts is available;
Customer parameters – you can add as many custom fields as you want to collect more info about your users;
User groups – set up user groups and address them separately in your app or through the admin panel – supported by other modules such as Messages;
Existing user base integration – our module supports connection to your system by storing your existent IDs table and matching them to new ones.

Need to know information

Before using the Users module please read the following:

Users API

Requests and Responses


URL	HTTP Verb	Supported formats	Action Description	Success HTTP Status Code
/users	GET	xml json	Retrieve API Users for current application	200
/users	POST	xml json	API User Sign Up	201
/users/{user_id}	GET	xml json	Show API User by identifier	200
/users/by_login	GET	xml json	Retrieve API User by login	200
/users/by_full_name	GET	xml json	Retrieve API User by full name	200
/users/by_facebook_id	GET	xml json	Retrieve API User by Facebook identifier	200
/users/by_twitter_id	GET	xml json	Retrieve API User by Twitter identifier	200
/users/by_email	GET	xml json	Retrieve API User by email	200
/users/by_tags	GET	xml json	Retrieve API Users By Tags	200
/users/{user_id}	PUT	xml json	Update API User by identifier	200
/users/{user_id}	DELETE	xml json	Delete API User by identifier	200
/users/external/{external_user_id}	GET	xml json	Retrieve API User by external user id	200
/users/external/{external_user_id}	DELETE	xml json	Delete API User by external user id	200

Retrieve API Users for current application

Retrieve all API Users for current application

Parameters

The request can contain all, some or none of these parameters.

Param	Required	Type	Value Example	Description
page	No	Unsigned Integer	3	Page number of the book of the results that you want to get. By default: 1
per_page	No	Unsigned Integer	15	The maximum number of results per page. Min: 1. Max: 100. By default: 10

Request

curl -X GET -d "token=d28fadea6fd9579c57430539b84a9a7e01e30633" http://api.quickblox.com/users.xml

curl -X GET -d "http://api.quickblox.com/users.json?token=f1435baba523599662f3c5f125316073d112a5af"

Response

<?xml version="1.0" encoding="UTF-8"?>
<users type="array" current_page="1" per_page="10" total_entries="28">
  <user>
    <blob-id type="integer" nil="true"></blob-id>
    <created-at type="datetime">2011-12-14T10:30:27Z</created-at>
    <email>user@domain.com</email>
    <external-user-id type="integer">2147483647</external-user-id>
    <facebook-id>10000313</facebook-id>
    <full-name>Full</full-name>
    <id type="integer">3</id>
    <last-request-at type="datetime">2011-12-20T10:17:17Z</last-request-at>
    <login>mylogin1</login>
    <owner-id type="integer">3</owner-id>
    <phone nil="true"></phone>
    <twitter-id>102444</twitter-id>
    <updated-at type="datetime">2012-01-11T12:10:16Z</updated-at>
    <website nil="true"></website>
    <tags type='array'>
      <tag type='ActsAsTaggableOn::Tag'>
        <id type='integer'>9</id>
        <name type='ActsAsTaggableOn::Tag'>weight</name>
      </tag>
    </tags>
  </user>
  ...
</users>

{
  "current_page": 1,
  "per_page": 10,
  "total_entries": 8,
  "items": [
    {
      "user": {
        "id": 87,
        "owner_id": 4,
        "full_name": "John Partizan",
        "email": "john@domain.com",
        "login": "Kitty",
        "phone": "7665891",
        "website": "http://partizan.com",
        "created_at": "2012-03-20T08:47:34Z",
        "updated_at": "2012-05-09T08:25:33Z",
        "last_request_at": "2012-05-08T13:07:37Z",
        "external_user_id": 158,
        "facebook_id": "1346987743",
        "twitter_id": "545878645453",
        "blob_id": null,
        "user_tags": "hello, world, hey"
      }
    },
  ...
  ]
}

API User Sign Up

API User sign up.

Parameters

Param	Required	Type	Value Example	Description
user[login]	Yes	String	mylogin	API User login
user[password]	Yes	String	mypassword	API User password
user[owner_id]	Yes	Integer	3	ID of API User owner
user[blob_id]	Optional	Integer	412	ID of associated blob (for example, API User photo)
user[email]	Optional	String	superuser@domain.com	API User e-mail
user[external_user_id]	Optional	Integer	21445	ID of API User in external system
user[facebook_id]	Optional	Integer	1000041	ID of API User in Facebook
user[twitter_id]	Optional	Integer	200655	ID of API User in Twitter
user[full_name]	Optional	String	Captain Jack	Full name
user[phone]	Optional	String	144-556488	Phone
user[website]	Optional	String	http://quickblox.com	Website
user[tag_list]	Optional	String	tag1,tag2,tag3	Tags

Request

curl -X POST -d "user[login]=Flower&user[password]=Flower&user[owner_id]=4360&user[email]=flower@domain.com&user[external_user_id]=7845636&user[facebook_id]=6357372&user[full_name]=Beautiful Flower&user[phone]=374257547&user[twitter_id]=67967327&user[website]=http://flower.com&user[tag_list]=type,name&token=7c1215fd0c682c8b4aa2f75979d618485297e5c0" http://api.quickblox.com/users.xml

curl -X POST -H "Content-Type: application/json" -d '{"user": {"login": "Lena", "password": "Lena", "owner_id": "4360", "email": "lena@domain.com", "external_user_id": "68764641", "facebook_id": "87964654", "twitter_id": "65765413614", "full_name": "Lena Laktionova", "phone": "87654351", "website": "http://lena.com", "tag_list": "name", "age"}, "token": "cf5709d6013fdb7a6787fbeb8340afed8aec4c69"}' http://api.quickblox.com/users.json

Response

<?xml version='1.0' encoding='UTF-8'?>
<user>
  <blob-id type='integer' nil='true'/>
  <created-at type='datetime'>2012-05-09T10:19:39Z</created-at>
  <email>flower@domain.com</email>
  <external-user-id type='integer'>7845636</external-user-id>
  <facebook-id>6357372</facebook-id>
  <full-name>Beautiful Flower</full-name>
  <id type='integer'>1635</id>
  <last-request-at type='datetime'>2012-05-09T10:19:39Z</last-request-at>
  <login>Flower</login>
  <owner-id type='integer'>4360</owner-id>
  <phone>374257547</phone>
  <twitter-id>67967327</twitter-id>
  <updated-at type='datetime'>2012-05-09T10:19:39Z</updated-at>
  <website>http://flower.com</website>
  <user-tags>type, name</user-tags>
</user>

{
  "user": {
    "id": 1639,
    "owner_id": 4360,
    "full_name": "Lena Laktionova",
    "email": "lena@domain.com",
    "login": "Lena",
    "phone": "87654351",
    "website": "http://lena.com",
    "created_at": "2012-05-09T10:24:26Z",
    "updated_at": "2012-05-09T10:24:26Z",
    "last_request_at": "2012-05-09T10:24:26Z",
    "external_user_id": 68764641,
    "facebook_id": "87964654",
    "twitter_id": "65765413614",
    "blob_id": null,
    "user_tags": "name, age"
  }
}

Show API User by identifier

Show API User.

Request

curl -X GET -d "http://api.quickblox.com/users/1326.xml?token=b284ddf44f5369611fe14e0e588f1cfa855116c8"

curl -X GET -d "http://api.quickblox.com/users/1326.json?token=6f8c8931e80d0d828341ef218e95584ac48195db"

Response

<?xml version="1.0" encoding="UTF-8"?>
<user>
  <blob-id type='integer' nil='true'/>
  <created-at type='datetime'>2012-04-23T09:15:55Z</created-at>
  <email>cloud@domain.com</email>
  <external-user-id type='integer'>283452</external-user-id>
  <facebook-id>8526573</facebook-id>
  <full-name>Double Cloud</full-name>
  <id type='integer'>1328</id>
  <last-request-at type='datetime'>2012-04-23T09:15:55Z</last-request-at>
  <login>Cloud</login>
  <owner-id type='integer'>4360</owner-id>
  <phone>78767356</phone>
  <twitter-id>2376876</twitter-id>
  <updated-at type='datetime'>2012-04-23T09:15:55Z</updated-at>
  <website>http://cloud.com</website>
  <user-tags>type, volume</user-tags>
</user>

{
  "user": {
    "id": 1326,
    "owner_id": 4360,
    "full_name": "Sun Burn",
    "email": "sun@domain.com",
    "login": "Sun",
    "phone": "7665727",
    "website": "http://sun.com",
    "created_at": "2012-04-23T09:09:26Z",
    "updated_at": "2012-05-09T10:06:39Z",
    "last_request_at": "2012-05-09T10:04:50Z",
    "external_user_id": 28552,
    "facebook_id": "4561356",
    "twitter_id": "1653489",
    "blob_id": null,
    "user_tags": "type, volume, name"
  }
}

Retrieve API User by login

Search API User by login

Parameters

Param	Required	Type	Value Example	Description
login	Yes	String	mylogin	API User login

Request

curl -X GET -d "http://api.quickblox.com/users/by_login.xml?login=Flower&token=b284ddf44f5369611fe14e0e588f1cfa855116c8"

curl -X GET -d "http://api.quickblox.com/users/by_login.json?login=Flower&token=6f8c8931e80d0d828341ef218e95584ac48195db"

Response

<?xml version='1.0' encoding='UTF-8'?>
<user>
  <blob-id type='integer' nil='true'/>
  <created-at type='datetime'>2012-05-09T10:19:39Z</created-at>
  <email>flower@domain.com</email>
  <external-user-id type='integer'>7845636</external-user-id>
  <facebook-id>6357372</facebook-id>
  <full-name>Beautiful Flower</full-name>
  <id type='integer'>1635</id>
  <last-request-at type='datetime'>2012-05-09T10:27:16Z</last-request-at>
  <login>Flower</login>
  <owner-id type='integer'>4360</owner-id>
  <phone>374257547</phone>
  <twitter-id>67967327</twitter-id>
  <updated-at type='datetime'>2012-05-09T10:27:16Z</updated-at>
  <website>http://flower.com</website>
  <user-tags>type, name</user-tags>
</user>

{
  "user": {
    "id": 1635,
    "owner_id": 4360,
    "full_name": "Beautiful Flower",
    "email": "flower@domain.com",
    "login": "Flower",
    "phone": "374257547",
    "website": "http://flower.com",
    "created_at": "2012-05-09T10:19:39Z",
    "updated_at": "2012-05-09T10:27:16Z",
    "last_request_at": "2012-05-09T10:27:16Z",
    "external_user_id": 7845636,
    "facebook_id": "6357372",
    "twitter_id": "67967327",
    "blob_id": null,
    "user_tags": "type, name"
  }
}

Retrieve API User by full name

Search API User by full name

Parameters

Param	Required	Type	Value Example	Description
full_name	Yes	String	Mike Senior	API User full name
page	No	Unsigned Integer	3	Page number of the book of the results that you want to get. By default: 1
per_page	No	Unsigned Integer	15	The maximum number of results per page. Min: 1. Max: 100. By default: 10

Request

curl -X GET -d "http://api.quickblox.com/users/by_full_name.xml?full_name=Double%20Cloud&token=b284ddf44f5369611fe14e0e588f1cfa855116c8"

curl -X GET -d "http://api.quickblox.com/users/by_full_name.json?full_name=Double%20Cloud&token=c9c18b1a2e7768027458e594583ea1a434707203"

Response

<?xml version='1.0' encoding='UTF-8'?>
<users type='array' current_page='1' per_page='10' total_entries='1'>
  <user>
    <blob-id type='integer' nil='true'/>
    <created-at type='datetime'>2012-04-23T09:15:55Z
    </created-at>
    <email>cloud@domain.com</email>
    <external-user-id type='integer'>283452</external-user-id>
    <facebook-id>8526573</facebook-id>
    <full-name>Double Cloud</full-name>
    <id type='integer'>1328</id>
    <last-request-at type='datetime'>2012-04-23T09:15:55Z</last-request-at>
    <login>Cloud</login>
    <owner-id type='integer'>4360</owner-id>
    <phone>78767356</phone>
    <twitter-id>2376876</twitter-id>
    <updated-at type='datetime'>2012-04-23T09:15:55Z</updated-at>
    <website>http://cloud.com</website>
    <tags type='array'>
      <tag type='ActsAsTaggableOn::Tag'>
        <id type='integer'>16</id>
        <name type='ActsAsTaggableOn::Tag'>type</name>
      </tag>
      <tag type='ActsAsTaggableOn::Tag'>
        <id type='integer'>17</id>
        <name type='ActsAsTaggableOn::Tag'>volume</name>
      </tag>
    </tags>
  </user>
</users>

{
  "current_page": 1,
  "per_page": 10,
  "total_entries": 1,
  "items": [
    {
      "user": {
        "blob_id": null,
        "created_at": "2012-04-23T09:15:55Z",
        "custom_parameters": null,
        "email": "cloud@domain.com",
        "external_user_id": 283452,
        "facebook_id": "8526573",
        "full_name": "Double Cloud",
        "id": 1328,
        "last_request_at": "2012-04-23T09:15:55Z",
        "login": "Cloud",
        "owner_id": 4360,
        "phone": "78767356",
        "twitter_id": "2376876",
        "updated_at": "2012-04-23T09:15:55Z",
        "website": "http://cloud.com",
        "tags": [
          {
            "tag": {
              "id": 16,
              "name": "type"
            }
          },
          {
            "tag": {
              "id": 17,
              "name": "volume"
            }
          }
        ]
      }
    }
  ]
}

Retrieve API User by Facebook identifier

Search API User by Facebook identifier

Parameters

Param	Required	Type	Value Example	Description
facebook_id	Yes	Integer	10000445	API User Facebook ID

Request

curl -X GET -d "http://api.quickblox.com/users/by_facebook_id.xml?facebook_id=4561356&token=c9c18b1a2e7768027458e594583ea1a434707203"

curl -X GET -d "http://api.quickblox.com/users/by_facebook_id.json?facebook_id=4561356&token=f1435baba523599662f3c5f125316073d112a5af"

Response

<?xml version='1.0' encoding='UTF-8'?>
<user>
  <blob-id type='integer' nil='true'/>
  <created-at type='datetime'>2012-04-23T09:09:26Z</created-at>
  <email>sun@domain.com</email>
  <external-user-id type='integer'>28552</external-user-id>
  <facebook-id>4561356</facebook-id>
  <full-name>Sun Burn</full-name>
  <id type='integer'>1326</id>
  <last-request-at type='datetime'>2012-04-23T09:38:34Z</last-request-at>
  <login>Sun</login>
  <owner-id type='integer'>4360</owner-id>
  <phone>7665727</phone>
  <twitter-id>1653489</twitter-id>
  <updated-at type='datetime'>2012-04-23T09:38:34Z</updated-at>
  <website>http://sun.com</website>
  <tags type='array'>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>13</id>
      <name type='ActsAsTaggableOn::Tag'>temperature</name>
    </tag>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>14</id>
      <name type='ActsAsTaggableOn::Tag'>humidity</name>
    </tag>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>15</id>
      <name type='ActsAsTaggableOn::Tag'>pressure</name>
    </tag>
  </tags>
</user>

{
  "user": {
    "blob_id": null,
    "created_at": "2012-04-23T09:09:26Z",
    "custom_parameters": {
 
    },
    "email": "sun@domain.com",
    "external_user_id": 28552,
    "facebook_id": "4561356",
    "full_name": "Sun Burn",
    "id": 1326,
    "last_request_at": "2012-04-23T09:38:34Z",
    "login": "Sun",
    "owner_id": 4360,
    "phone": "7665727",
    "twitter_id": "1653489",
    "updated_at": "2012-04-23T09:38:34Z",
    "website": "http://sun.com",
    "tags": [
      {
        "tag": {
          "id": 13,
          "name": "temperature"
        }
      },
      {
        "tag": {
          "id": 14,
          "name": "humidity"
        }
      },
      {
        "tag": {
          "id": 15,
          "name": "pressure"
        }
      }
    ]
  }
}

Retrieve API User by Twitter identifier

Parameters

Param	Required	Type	Value Example	Description
twitter_id	Yes	Integer	100500	API User Twitter ID

Request

curl -X GET -d "http://api.quickblox.com/users/by_twitter_id.xml?twitter_id=1653489&token=b284ddf44f5369611fe14e0e588f1cfa855116c8"

curl -X GET -d "http://api.quickblox.com/users/by_twitter_id.json?twitter_id=1653489&token=c9c18b1a2e7768027458e594583ea1a434707203"

Response

<?xml version="1.0" encoding="UTF-8"?>
<user>
  <blob-id type='integer' nil='true'/>
  <created-at type='datetime'>2012-04-23T09:09:26Z</created-at>
  <email>sun@domain.com</email>
  <external-user-id type='integer'>28552</external-user-id>
  <facebook-id>4561356</facebook-id>
  <full-name>Sun Burn</full-name>
  <id type='integer'>1326</id>
  <last-request-at type='datetime'>2012-04-23T09:38:34Z</last-request-at>
  <login>Sun</login>
  <owner-id type='integer'>4360</owner-id>
  <phone>7665727</phone>
  <twitter-id>1653489</twitter-id>
  <updated-at type='datetime'>2012-04-23T09:38:34Z</updated-at>
  <website>http://sun.com</website>
  <tags type='array'>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>13</id>
      <name type='ActsAsTaggableOn::Tag'>temperature</name>
    </tag>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>14</id>
      <name type='ActsAsTaggableOn::Tag'>humidity</name>
    </tag>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>15</id>
      <name type='ActsAsTaggableOn::Tag'>pressure</name>
    </tag>
  </tags>
</user>

{
  "user": {
    "blob_id": null,
    "created_at": "2012-04-23T09:09:26Z",
    "custom_parameters": null,
    "email": "sun@domain.com",
    "external_user_id": 28552,
    "facebook_id": "4561356",
    "full_name": "Sun Burn",
    "id": 1326,
    "last_request_at": "2012-04-23T09:38:34Z",
    "login": "Sun",
    "owner_id": 4360,
    "phone": "7665727",
    "twitter_id": "1653489",
    "updated_at": "2012-04-23T09:38:34Z",
    "website": "http://sun.com",
    "tags": [
      {
        "tag": {
          "id": 13,
          "name": "temperature"
        }
      },
      {
        "tag": {
          "id": 14,
          "name": "humidity"
        }
      },
      {
        "tag": {
          "id": 15,
          "name": "pressure"
        }
      }
    ]
  }
}

Retrieve API User by email

Parameters

Param	Required	Type	Value Example	Description
email	Yes	String	mike@senior.com	API User email

Request

curl -X GET -d "http://api.quickblox.com/users/by_email.xml?email=sun@domain.com&token=b284ddf44f5369611fe14e0e588f1cfa855116c8"

curl -X GET -d "http://api.quickblox.com/users/by_email.json?email=sun@domain.com&token=61bbb37dee2b7547f647cc269c4083f1a1ce37a7"

Response

<?xml version="1.0" encoding="UTF-8"?>
<user>
  <blob-id type='integer' nil='true'/>
  <created-at type='datetime'>2012-04-23T09:09:26Z</created-at>
  <email>sun@domain.com</email>
  <external-user-id type='integer'>28552</external-user-id>
  <facebook-id>4561356</facebook-id>
  <full-name>Sun Burn</full-name>
  <id type='integer'>1326</id>
  <last-request-at type='datetime'>2012-04-23T09:38:34Z</last-request-at>
  <login>Sun</login>
  <owner-id type='integer'>4360</owner-id>
  <phone>7665727</phone>
  <twitter-id>1653489</twitter-id>
  <updated-at type='datetime'>2012-04-23T09:38:34Z</updated-at>
  <website>http://sun.com</website>
  <tags type='array'>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>13</id>
      <name type='ActsAsTaggableOn::Tag'>temperature</name>
    </tag>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>14</id>
      <name type='ActsAsTaggableOn::Tag'>humidity</name>
    </tag>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>15</id>
      <name type='ActsAsTaggableOn::Tag'>pressure</name>
    </tag>
  </tags>
</user>

{
  "user": {
    "blob_id": null,
    "created_at": "2012-04-23T09:09:26Z",
    "custom_parameters": null,
    "email": "sun@domain.com",
    "external_user_id": 28552,
    "facebook_id": "4561356",
    "full_name": "Sun Burn",
    "id": 1326,
    "last_request_at": "2012-04-23T09:38:34Z",
    "login": "Sun",
    "owner_id": 4360,
    "phone": "7665727",
    "twitter_id": "1653489",
    "updated_at": "2012-04-23T09:38:34Z",
    "website": "http://sun.com",
    "tags": [
      {
        "tag": {
          "id": 13,
          "name": "temperature"
        }
      },
      {
        "tag": {
          "id": 14,
          "name": "humidity"
        }
      },
      {
        "tag": {
          "id": 15,
          "name": "pressure"
        }
      }
    ]
  }
}

Retrieve API User by tags

Search API User by tags

Parameters

Param	Required	Type	Value Example	Description
tags	Yes	String	tag1,tag2,tag3	API User tag(s)
page	No	Unsigned Integer	3	Page number of the book of the results that you want to get. By default: 1
per_page	No	Unsigned Integer	15	The maximum number of results per page. Min: 1. Max: 100. By default: 5

Request

curl -X GET -d "http://api.quickblox.com/users/by_tags.xml?tags=man&token=b284ddf44f5369611fe14e0e588f1cfa855116c8"

curl -X GET -d "http://api.quickblox.com/users/by_tags.json?&token=3391435dc93a22fc3d864a16e8026f60417379ef&tags=singer"

Response

<users type='array' current_page='1' per_page='5' total_entries='1'>
  <user>
    <blob-id type='integer' nil='true'/>
    <created-at type='datetime'>2012-03-01T11:03:06Z</created-at>
    <email nil='true'/>
    <external-user-id type='integer' nil='true'/>
    <facebook-id nil='true'/>
    <full-name nil='true'/>
    <id type='integer'>4</id>
    <last-request-at type='datetime'>2012-03-01T17:40:08Z</last-request-at>
    <login>mobile2</login>
    <owner-id type='integer'>3</owner-id>
    <phone nil='true'/>
    <twitter-id nil='true'/>
    <updated-at type='datetime'>2012-03-01T17:40:08Z</updated-at>
    <website nil='true'/>
    <tags type='array'>
      <tag type='ActsAsTaggableOn::Tag'>
        <id type='integer'>1</id>
        <name type='ActsAsTaggableOn::Tag'>man</name>
      </tag>
    </tags>
  </user>
</users>

{
  "current_page": 1,
  "per_page": 5,
  "total_entries": 1,
  "items": [
    {
      "blob_id": null,
      "created_at": "2012-03-23T14:40:23Z",
      "custom_parameters": null,
      "email": null,
      "external_user_id": null,
      "facebook_id": null,
      "full_name": "Freddie",
      "id": 98,
      "last_request_at": "2012-03-23T16:01:23Z",
      "login": "fred",
      "owner_id": 5,
      "phone": null,
      "twitter_id": null,
      "updated_at": "2012-03-23T16:01:23Z",
      "website": null,
      "tags": [
        {
          "tag": {
            "id": 26,
            "name": "singer"
          }
        }
      ]
    }
  ]
}

Update API User by identifier

Parameters

Param	Required	Type	Value Example	Description
user[blob_id]	Optional	Integer	412	ID of associated blob (for example, API User photo)
user[email]	Optional	String	superuser@domain.com	API User e-mail
user[external_user_id]	Optional	Integer	21445	ID of API User in external system
user[facebook_id]	Optional	Integer	1000041	ID of API User in Facebook
user[twitter_id]	Optional	Integer	200655	ID of API User in Twitter
user[full_name]	Optional	String	Captain Jack	Full name
user[phone]	Optional	String	144-556488	Phone
user[website]	Optional	String	http://quickblox.com	Website
user[tag_list]	Optional	String	tag1,tag2,tag3	Tags
user[password]	Optional	String	newsupersecure	New password
user[old_password]	Optional	String	oldpassword	Old user password (required only if new password provided)

Request

curl -X PUT -d "http://api.quickblox.com/users/1326?user[full_name]=Sunny&user[email]=sunny@domain.com&token=7483d80bb9caddd504764d85b050c85755aecc84"

curl -X PUT -H "Content-Type: application/json" -d '{"user": {"full_name": "Sun", "email: sun@domain.com"}, "token": "7483d80bb9caddd504764d85b050c85755aecc84"}'    http://api.quickblox.com/users/1328.json?

Response

<?xml version="1.0" encoding="UTF-8"?>
<user>
  <blob-id type='integer' nil='true'/>
  <created-at type='datetime'>2012-04-23T09:09:26Z</created-at>
  <email>sunny@domain.com</email>
  <external-user-id type='integer'>28552</external-user-id>
  <facebook-id>4561356</facebook-id>
  <full-name>Sunny</full-name>
  <id type='integer'>1326</id>
  <last-request-at type='datetime'>2012-04-23T12:07:48Z</last-request-at>
  <login>Sun</login>
  <owner-id type='integer'>4360</owner-id>
  <phone>7665727</phone>
  <twitter-id>1653489</twitter-id>
  <updated-at type='datetime'>2012-04-23T12:08:02Z</updated-at>
  <website>http://sun.com</website>
  <tags type='array'>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>13</id>
      <name type='ActsAsTaggableOn::Tag'>temperature</name>
    </tag>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>14</id>
      <name type='ActsAsTaggableOn::Tag'>humidity</name>
    </tag>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>15</id>
      <name type='ActsAsTaggableOn::Tag'>pressure</name>
    </tag>
  </tags>
</user>

{
  "user": {
    "blob_id": null,
    "created_at": "2012-04-23T09:09:26Z",
    "custom_parameters": null,
    "email": "sun@domain.com",
    "external_user_id": 28552,
    "facebook_id": "4561356",
    "full_name": "Sun",
    "id": 1326,
    "last_request_at": "2012-04-23T12:07:48Z",
    "login": "Sun",
    "owner_id": 4360,
    "phone": "7665727",
    "twitter_id": "1653489",
    "updated_at": "2012-04-23T12:13:16Z",
    "website": "http://sun.com",
    "tags": [
      {
        "tag": {
          "id": 13,
          "name": "temperature"
        }
      },
      {
        "tag": {
          "id": 14,
          "name": "humidity"
        }
      },
      {
        "tag": {
          "id": 15,
          "name": "pressure"
        }
      }
    ]
  }
}

Retrieve API User by external user id

Request

curl -X GET -d "http://api.quickblox.com/users/external/28552.xml?token=b284ddf44f5369611fe14e0e588f1cfa855116c8"

curl -X GET -d "http://api.quickblox.com/users/external/28552.json?&token=3391435dc93a22fc3d864a16e8026f60417379ef"

Response

<?xml version="1.0" encoding="UTF-8"?>
<user>
  <blob-id type='integer' nil='true'/>
  <created-at type='datetime'>2012-04-23T09:09:26Z</created-at>
  <email>sun@domain.com</email>
  <external-user-id type='integer'>28552</external-user-id>
  <facebook-id>4561356</facebook-id>
  <full-name>Sun</full-name>
  <id type='integer'>1326</id>
  <last-request-at type='datetime'>2012-04-23T12:07:48Z</last-request-at>
  <login>Sun</login>
  <owner-id type='integer'>4360</owner-id>
  <phone>7665727</phone>
  <twitter-id>1653489</twitter-id>
  <updated-at type='datetime'>2012-04-23T12:13:16Z</updated-at>
  <website>http://sun.com</website>
  <tags type='array'>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>13</id>
      <name type='ActsAsTaggableOn::Tag'>temperature</name>
    </tag>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>14</id>
      <name type='ActsAsTaggableOn::Tag'>humidity</name>
    </tag>
    <tag type='ActsAsTaggableOn::Tag'>
      <id type='integer'>15</id>
      <name type='ActsAsTaggableOn::Tag'>pressure</name>
    </tag>
  </tags>
</user>

{
  "user": {
    "blob_id": null,
    "created_at": "2012-04-23T09:09:26Z",
    "custom_parameters": null,
    "email": "sun@domain.com",
    "external_user_id": 28552,
    "facebook_id": "4561356",
    "full_name": "Sun",
    "id": 1326,
    "last_request_at": "2012-04-23T12:07:48Z",
    "login": "Sun",
    "owner_id": 4360,
    "phone": "7665727",
    "twitter_id": "1653489",
    "updated_at": "2012-04-23T12:13:16Z",
    "website": "http://sun.com",
    "tags": [
      {
        "tag": {
          "id": 13,
          "name": "temperature"
        }
      },
      {
        "tag": {
          "id": 14,
          "name": "humidity"
        }
      },
      {
        "tag": {
          "id": 15,
          "name": "pressure"
        }
      }
    ]
  }
}

Delete API User by identifier

Request

curl -X DELETE -d "http://api.quickblox.com/users/35.xml?token=b284ddf44f5369611fe14e0e588f1cfa855116c8"

curl -X DELETE -d "http://api.quickblox.com/users/36.json?token=b284ddf44f5369611fe14e0e588f1cfa855116c8"

Response

Empty body, status: 200

Status: 200, null

Delete API User by external user id

Request

curl -X DELETE -d "http://api.quickblox.com/users/external/696.xml?token=b284ddf44f5369611fe14e0e588f1cfa855116c8"

curl -X DELETE -d "http://api.quickblox.com/users/external/697.json?token=b284ddf44f5369611fe14e0e588f1cfa855116c8"

Response

Empty body, status: 200

Status: 200, null

QuickBlox Developers (API docs, code samples, SDK)

Users

Contents

Summary

Need to know information

Users API

Requests and Responses

Retrieve API Users for current application

Parameters

Request

Response

API User Sign Up

Parameters

Request

Response

Show API User by identifier

Request

Response

Retrieve API User by login

Parameters

Request

Response

Retrieve API User by full name

Parameters

Request

Response

Retrieve API User by Facebook identifier

Parameters

Request

Response

Retrieve API User by Twitter identifier

Parameters

Request

Response

Retrieve API User by email

Parameters

Request

Response

Retrieve API User by tags

Parameters

Request

Response

Update API User by identifier

Parameters

Request

Response

Retrieve API User by external user id

Request

Response

Delete API User by identifier

Request

Response

Delete API User by external user id

Request

Response