GET login/users/:user id
From Social ID Developers
(Difference between revisions)
(3 intermediate revisions by one user not shown) | |||
Line 15: | Line 15: | ||
| width="200px" | required | | width="200px" | required | ||
| user identifier. | | user identifier. | ||
− | | | + | |- |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
! align="left" width="200px" | fields | ! align="left" width="200px" | fields | ||
| width="200px" | optional | | width="200px" | optional | ||
Line 27: | Line 23: | ||
== Authentication == | == Authentication == | ||
− | This API requires | + | This API requires Account authentication. See [[Authentication]]. |
== Response == | == Response == | ||
Line 89: | Line 85: | ||
"username": "john_doe", | "username": "john_doe", | ||
"email_address": "john_doe@domain.com", | "email_address": "john_doe@domain.com", | ||
− | "active": | + | "active": true, |
− | "confirmed": | + | "confirmed": true, |
+ | "locked": false | ||
} | } | ||
Line 118: | Line 115: | ||
"username": "john_doe", | "username": "john_doe", | ||
"email_address": "john_doe@domain.com", | "email_address": "john_doe@domain.com", | ||
− | "active": | + | "active": true, |
− | "confirmed": | + | "confirmed": true, |
+ | "locked": false | ||
} | } |
Latest revision as of 22:50, 17 November 2022
Contents |
Description
Returns user information, including his profile (if required).
Resource URL
GET https://api.socialidnow.com/v1/marketing/login/users/:user_id
Parameters
URL Parameters
user_id | required | user identifier. |
---|---|---|
fields | optional | a list of user profile field names to be returned, joined by commas. See Social Profile Fields. |
Authentication
This API requires Account authentication. See Authentication.
Response
Response Body
The following fields are returned:
id | user identifier in the Social Login. |
---|---|
profile | a hash with the fields request by the parameter "fields". This field will only be present if at least one field is requested. |
signed_in_at | date of user latest login. |
signed_up_at | date of user creation. |
token | user token. This token is used as user identifier in some Javascript APIs. See Social Login Tokens for more details. |
username | username. Set by POST login/users and PUT login/users/:user_id apis. |
email_address | email_address. Set by POST login/users and PUT login/users/:user_id apis. |
active | boolean flag to inform whether the user is activated for login. Set by PUT login/users/:user_id/activate and PUT login/users/:user_id/deactivate apis. |
confirmed | boolean flag to inform whether the user has confirmed his email address. See POST login/users/send_email_confirmation for instructions on how to add email address confirmation. |
locked | boolean flag to inform whether the user is locked due to too many login attempts with an incorrect password. See Login App Security Settings and PUT login/users/:user_id/unlock. |
Examples
Without fields
Request
Returns information for user "340":
curl -X GET 'https://api.socialidnow.com/v1/marketing/login/users/340' \ --user <api_id>:<api_secret>
Response
Response Body
{ "id": 340, "signed_in_at": "2013-08-08T03:32:40Z", "signed_up_at": "2012-10-04T14:34:10Z", "token": "12345678901234567890123456789012", "username": "john_doe", "email_address": "john_doe@domain.com", "active": true, "confirmed": true, "locked": false }
With fields
Request
Returns information for user "340" with profile fields display_name, verified_email and current_location:
curl -X GET 'https://api.socialidnow.com/v1/marketing/login/users/340?fields=display_name,verified_email,current_location' \ --user <api_id>:<api_secret>
Response
Response Body
{ "id": 340, "profile": { "current_location": "Campinas, SP, Brasil", "display_name": "John Doe", "verified_email": "john.doe@somedomain.com" }, "signed_in_at": "2013-08-08T03:32:40Z", "signed_up_at": "2012-10-04T14:34:10Z", "token": "12345678901234567890123456789012", "username": "john_doe", "email_address": "john_doe@domain.com", "active": true, "confirmed": true, "locked": false }