PUT login/users/:user id

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 
== Description ==
 
== Description ==
  
Updates username/e-mail/password information of an user.
+
Updates username/e-mail/password information of a user.
  
 
== Resource URL ==
 
== Resource URL ==
  
   PUT https://api.socialidnow.com/v1/marketing/login/users
+
   PUT https://api.socialidnow.com/v1/marketing/login/users/:user_id
  
 
== Parameters ==
 
== Parameters ==
 
=== URL Parameters ===
 
 
{|
 
! align="left" width="200px"  | username <sup>1</sup>
 
| width="200px" | optional
 
| username.
 
|-
 
! align="left" width="200px"  | email_address <sup>1</sup>
 
| width="200px" | optional
 
| user e-mail address.
 
|}
 
  
 
=== JSON Parameters ===
 
=== JSON Parameters ===
Line 40: Line 28:
 
| user password.
 
| user password.
 
|}
 
|}
 
<sup>1</sup> At least one of these fields must be given to identify the user.
 
  
 
== Authentication ==
 
== Authentication ==
Line 73: Line 59:
 
== Examples ==
 
== Examples ==
  
=== Using username ===
+
=== Request ===
 
+
==== Request ====
+
 
+
curl -iX PUT 'https://api.socialidnow.com/v1/marketing/login/users?username=new_user' \
+
-d '{
+
      "user": {
+
        "username":"brand_new_user",
+
        "email_address":"brand_new_user@user_domain.com",
+
        "password":"brand_new_user_secret"
+
        }
+
      }' \
+
-H 'Content-type: application/json' \
+
--user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
+
 
+
==== Response ====
+
 
+
===== Response Headers =====
+
 
+
HTTP/1.1 200 Ok
+
Status: 200
+
 
+
=== Using email_address ===
+
 
+
==== Request ====
+
  
  curl -iX PUT 'https://api.socialidnow.com/v1/marketing/login/users?email_address=new_user@user_domain.com' \
+
  curl -iX PUT 'https://api.socialidnow.com/v1/marketing/login/users/345' \
 
  -d '{
 
  -d '{
 
       "user": {
 
       "user": {
Line 110: Line 72:
 
  --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
 
  --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
  
==== Response ====
+
=== Response ===
  
===== Response Headers =====
+
==== Response Headers ====
  
 
  HTTP/1.1 200 Ok
 
  HTTP/1.1 200 Ok
 
  Status: 200
 
  Status: 200

Revision as of 15:25, 20 February 2015

Contents

Description

Updates username/e-mail/password information of a user.

Resource URL

  PUT https://api.socialidnow.com/v1/marketing/login/users/:user_id

Parameters

JSON Parameters

user required a hash in the format field:value, with the necessary fields to update the user:
username optional username.
email_address optional user e-mail address.
password optional user password.

Authentication

This API requires Social Login App authentication. See Authentication.

Response

Response Status

ok (200) The user was updated successfully.
bad_request (400) Some required parameter was not informed.
unauthorized (401) The authentication is wrong. See Authentication.
not_found (404) The user was not found.
unprocessable_entity (422) Validation error in the field "user".
internal_server_error (500) An unknown error happened.

Examples

Request

curl -iX PUT 'https://api.socialidnow.com/v1/marketing/login/users/345' \
-d '{
      "user": {
        "username":"brand_new_user",
        "email_address":"brand_new_user@user_domain.com",
        "password":"brand_new_user_secret"
       }
     }' \
-H 'Content-type: application/json' \
--user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf

Response

Response Headers

HTTP/1.1 200 Ok
Status: 200
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox