PUT login/users/:user id

(Difference between revisions)
Jump to: navigation, search
 
Line 1: Line 1:
−
#REDIRECT [[PUT login/users PT-BR]]
+
== Description ==
 +
 
 +
Updates username/e-mail/password information of an user.
 +
 
 +
== Resource URL ==
 +
 
 +
  PUT https://api.socialidnow.com/v1/marketing/login/users
 +
 
 +
== 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 ===
 +
 
 +
{|
 +
! align="left" width="200px"  | user
 +
| width="200px" | required
 +
| a hash in the format field:value, with the necessary fields to update the user:
 +
|-
 +
! align="left" width="180px"  style="padding-left: 20px" | username
 +
| width="200px" | optional
 +
| username.
 +
|-
 +
! align="left" width="180px"  style="padding-left: 20px" | email_address
 +
| width="200px" | optional
 +
| user e-mail address.
 +
|-
 +
! align="left" width="180px"  style="padding-left: 20px" | password
 +
| width="200px" | optional
 +
| user password.
 +
|}
 +
 
 +
<sup>1</sup> At least one of these fields must be given to identify the user.
 +
 
 +
== Authentication ==
 +
 
 +
This API requires Social Login App authentication. See [[Authentication]].
 +
 
 +
== Response ==
 +
 
 +
==== Response Status ====
 +
 
 +
{|
 +
! align="left" width="200px" | ok (200)
 +
| The user was updated successfully.
 +
|-
 +
! align="left" width="200px" | bad_request (400)
 +
| Some required parameter was not informed.
 +
|-
 +
! align="left" width="200px" | unauthorized (401)
 +
| The authentication is wrong. See [[Authentication]].
 +
|-
 +
! align="left" width="200px" | not_found (404)
 +
| The user was not found.
 +
|-
 +
! align="left" width="200px" | unprocessable_entity (422)
 +
| Validation error in the field "user".
 +
|-
 +
! align="left" width="200px" | internal_server_error (500)
 +
| An unknown error happened.
 +
|}
 +
 
 +
== Examples ==
 +
 
 +
=== Using username ===
 +
 
 +
==== 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' \
 +
-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

Revision as of 03:54, 4 November 2014

Contents

Description

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

Resource URL 

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

Parameters

URL Parameters

username 1 optional username.
email_address 1 optional user e-mail address.

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.

1 At least one of these fields must be given to identify the user.

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

Using username

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' \
-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
Retrieved from "https://dev.socialidnow.com/index.php?title=PUT_login/users/:user_id&oldid=1561"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox