OAuth APIs

(Difference between revisions)
Jump to: navigation, search
Line 8: Line 8:
  
 
{|
 
{|
! align="left" width="200px"| Resource
+
! align="left" width="300px"| Resource
 
! align="left" width="200px"| Grant Type
 
! align="left" width="200px"| Grant Type
 
! align="left"| Description
 
! align="left"| Description
Line 27: Line 27:
 
| refresh_token
 
| refresh_token
 
| Refreshes an access token, generating a new one.
 
| Refreshes an access token, generating a new one.
 +
|}
 +
 +
== Users ==
 +
 +
{|
 +
! align="left" width="300px"| Resource
 +
! align="left"| Description
 +
|-
 +
| [[GET /oauth/login/user | GET login/user]]
 +
| Returns user information, including his/her profile (if required).
 +
|-
 +
| [[POST oauth/login/users | POST login/users]]
 +
| Creates a new user manually, given username and/or e-mail.
 +
|-
 +
| [[PUT oauth/login/user | PUT login/user]]
 +
| Updates username/e-mail/password information of an user.
 +
|-
 +
| [[POST oauth/login/users/reset_password_email | POST login/users/reset_password_email]]
 +
| Sends a reset password e-mail for a user given its username or e-mail.
 +
|}
 +
 +
== User Data ==
 +
 +
{|
 +
! align="left" width="300px"| Resource
 +
! align="left"| Description
 +
|-
 +
| [[GET oauth/login/user/data | GET login/user/data]]
 +
| Returns user custom profile information.
 +
|-
 +
| [[PUT oauth/login/user/data | PUT login/user/data]]
 +
| Updates user custom profile information.
 +
|}
 +
 +
== Devices ==
 +
 +
{|
 +
! align="left" width="300px"| Resource
 +
! align="left"| Description
 +
|-
 +
| [[POST oauth/push_notifications/devices | POST push_notifications/devices]]
 +
| Adds a new device to the Social Login App devices list.
 +
|-
 +
| [[POST oauth/ user/push_notifications/devices | POST user/push_notifications/devices]]
 +
| Relates a device with a Social Login User.
 
|}
 
|}

Revision as of 18:32, 7 August 2015

Some Social-ID NOW APIs require OAuth 2.0 authentication instead of HTTP Basic.

In order to access them one needs first to request an access token through the token endpoint. Each access token has its own scope and allows a certain set of APIs.

Please, refer to https://tools.ietf.org/html/rfc6749 if you are not familiar with the OAuth 2.0 protocol.

Contents

Token Endpoint

Resource Grant Type Description
POST /oauth/token password Generates a new user access token given a combination of username/email_address and password.
POST /oauth/token provider_credentials Generates a new user access token given an oauth token issued by an external provider.
POST /oauth/token client_credentials Generates a new app access token.
POST /oauth/token refresh_token Refreshes an access token, generating a new one.

Users

Resource Description
GET login/user Returns user information, including his/her profile (if required).
POST login/users Creates a new user manually, given username and/or e-mail.
PUT login/user Updates username/e-mail/password information of an user.
POST login/users/reset_password_email Sends a reset password e-mail for a user given its username or e-mail.

User Data

Resource Description
GET login/user/data Returns user custom profile information.
PUT login/user/data Updates user custom profile information.

Devices

Resource Description
POST push_notifications/devices Adds a new device to the Social Login App devices list.
POST user/push_notifications/devices Relates a device with a Social Login User.
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox