Login & Management APIs

(Difference between revisions)
Jump to: navigation, search
Line 6: Line 6:
 
|-
 
|-
 
| [[GET login/info]]
 
| [[GET login/info]]
| Valida um token passado para o callback_url e retorna informações sobre um login social.
+
| Validates the token given to the callback_url and returns social login information.  
 
|}
 
|}
  
Line 16: Line 16:
 
|-
 
|-
 
| [[GET login/sign_ins/:id]]
 
| [[GET login/sign_ins/:id]]
| Retorna informações sobre um sign_in.
+
| Returns sign_in information.
 
|-
 
|-
 
|[[POST login/apps/:app_id/sign_ins]]
 
|[[POST login/apps/:app_id/sign_ins]]
| Cria um novo sign_in dado um user_id.
+
| Creates a new sign_in given an user_id.
 
|-
 
|-
 
|[[POST login/apps/:app_id/sign_ins/facebook]]
 
|[[POST login/apps/:app_id/sign_ins/facebook]]
| Cria um novo sign_in dada uma credencial do Facebook.
+
| Creates a new sign_in given a Facebook credential.
 
|-
 
|-
 
|[[POST login/apps/:app_id/sign_ins/twitter]]
 
|[[POST login/apps/:app_id/sign_ins/twitter]]
| Cria um novo sign_in dada uma credencial do Twitter.
+
| Creates a new sign_in given a Twitter credential.
 
|-
 
|-
 
|[[POST login/apps/:app_id/sign_ins/linkedin]]
 
|[[POST login/apps/:app_id/sign_ins/linkedin]]
| Cria um novo sign_in dada uma credencial do LinkedIn.
+
| Creates a new sign_in given a LinkedIn credential.
 
|-
 
|-
 
|[[POST login/apps/:app_id/sign_ins/gplus]]
 
|[[POST login/apps/:app_id/sign_ins/gplus]]
| Cria um novo sign_in dada uma credencial do Google+.
+
| Creates a new sign_in given a Google+ credential.
 
|}
 
|}
  
Line 41: Line 41:
 
|-
 
|-
 
| [[DELETE login/connections/:id]]
 
| [[DELETE login/connections/:id]]
| Encerra uma conexão (logout).
+
| Closes a connection (logout).
 
|-
 
|-
 
|[[POST login/apps/:app_id/connections/email]]
 
|[[POST login/apps/:app_id/connections/email]]
| Cria uma conexão dado um e-mail.
+
| Creates a connection given an e-mail.
 
|-
 
|-
 
|[[POST login/connections/:id]]
 
|[[POST login/connections/:id]]
| Mantém a conexão ativa.
+
| Keeps the connection alive.
 
|}
 
|}
  
Line 57: Line 57:
 
|-
 
|-
 
| [[GET login/users/:user_id]]
 
| [[GET login/users/:user_id]]
| Retorna informações do usuário, incluindo seu perfil (se desejado).
+
| Returns user information, including his profile (if required).
 
|-
 
|-
 
| [[GET login/users/:user_id/profile]]
 
| [[GET login/users/:user_id/profile]]
| Retorna o perfil parcial ou completo do usuário.
+
| Returns the user profile (complete or partial).
 
|-
 
|-
 
| [[PUT login/users/:user_id/token]]
 
| [[PUT login/users/:user_id/token]]
| Gera um novo token para o usuário (user_token).
+
| Generates a new token (user_token) for the user.
 
|-
 
|-
 
| [[PUT login/users/:user_id/move_to/:target_id]]
 
| [[PUT login/users/:user_id/move_to/:target_id]]
| Move os dados de um usuário para outro usuário e depois o remove.
+
| Moves the user data to antoher user and then removes him.
 
|-
 
|-
 
| [[POST login/users]]
 
| [[POST login/users]]
| Cria um novo usuário manualmente utilizando username e/ou email.
+
| Creates a new user manually, given username and/or e-mail.
 
|-
 
|-
 
| [[PUT login/users/:user_id]]
 
| [[PUT login/users/:user_id]]
| Atualiza informações de username/email/password de um usuário.
+
| Updates username/e-mail/password information of an user.
 
|-
 
|-
 
| [[GET login/users/find_by]]
 
| [[GET login/users/find_by]]
| Busca um usuário através de username ou email.
+
| Finds an user through username or e-mail.
 
|-
 
|-
 
| [[POST login/users/login]]
 
| [[POST login/users/login]]
| Cria um sign in para um usuário através de password e username ou email.
+
| Creates a sign in for an user given its password and username or e-mail.
 
|-
 
|-
 
| [[PUT login/users/:user_id/activate]]
 
| [[PUT login/users/:user_id/activate]]
| Ativa um usuário para realização de login.
+
| Activates an user for login.
 
|-
 
|-
 
| [[PUT login/users/:user_id/deactivate]]
 
| [[PUT login/users/:user_id/deactivate]]
| Desativa um usuário para realização de login.
+
| Deactivates an user for login.
 
|}
 
|}
  
Line 94: Line 94:
 
|-
 
|-
 
| [[POST login/users/:user_id/updates/facebook]]
 
| [[POST login/users/:user_id/updates/facebook]]
| Posta uma mensagem na timeline do Facebook do usuário.
+
| Posts a message to the user Facebook timeline.
 
|}
 
|}
  
Line 104: Line 104:
 
|-
 
|-
 
| [[POST login/users/:user_id/mac_addresses]]
 
| [[POST login/users/:user_id/mac_addresses]]
| Cria um novo mac address associado a um usuário.
+
| Creates a new mac address associated with an user.
 
|}
 
|}
  
Line 114: Line 114:
 
|-
 
|-
 
| [[GET login/apps/social_apps]]
 
| [[GET login/apps/social_apps]]
| Retorna as Social Apps da aplicação de Social Login
+
| Returns all Social Apps from the Social Login App.
 
|}
 
|}
  
Line 124: Line 124:
 
|-
 
|-
 
| [[GET login/users/:user_id/data]]
 
| [[GET login/users/:user_id/data]]
| Retorna informações do perfil customizado do usuário.
+
| Returns user custom profile information.
 
|-
 
|-
 
| [[PUT login/users/:user_id/data]]
 
| [[PUT login/users/:user_id/data]]
| Atualiza as informações do perfil customizado do usuário.
+
| Updates user custom profile information.
 
|}
 
|}

Revision as of 21:23, 31 October 2014

Contents

Info

Resource Description
GET login/info Validates the token given to the callback_url and returns social login information.

Sign ins

Resource Description
GET login/sign_ins/:id Returns sign_in information.
POST login/apps/:app_id/sign_ins Creates a new sign_in given an user_id.
POST login/apps/:app_id/sign_ins/facebook Creates a new sign_in given a Facebook credential.
POST login/apps/:app_id/sign_ins/twitter Creates a new sign_in given a Twitter credential.
POST login/apps/:app_id/sign_ins/linkedin Creates a new sign_in given a LinkedIn credential.
POST login/apps/:app_id/sign_ins/gplus Creates a new sign_in given a Google+ credential.

Connections

Resource Description
DELETE login/connections/:id Closes a connection (logout).
POST login/apps/:app_id/connections/email Creates a connection given an e-mail.
POST login/connections/:id Keeps the connection alive.

Users

Resource Description
GET login/users/:user_id Returns user information, including his profile (if required).
GET login/users/:user_id/profile Returns the user profile (complete or partial).
PUT login/users/:user_id/token Generates a new token (user_token) for the user.
PUT login/users/:user_id/move_to/:target_id Moves the user data to antoher user and then removes him.
POST login/users Creates a new user manually, given username and/or e-mail.
PUT login/users/:user_id Updates username/e-mail/password information of an user.
GET login/users/find_by Finds an user through username or e-mail.
POST login/users/login Creates a sign in for an user given its password and username or e-mail.
PUT login/users/:user_id/activate Activates an user for login.
PUT login/users/:user_id/deactivate Deactivates an user for login.

User Updates

Resource Description
POST login/users/:user_id/updates/facebook Posts a message to the user Facebook timeline.

User Mac Address

Resource Description
POST login/users/:user_id/mac_addresses Creates a new mac address associated with an user.

Social Apps

Resource Description
GET login/apps/social_apps Returns all Social Apps from the Social Login App.

User Data

Resource Description
GET login/users/:user_id/data Returns user custom profile information.
PUT login/users/:user_id/data Updates user custom profile information.
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox