Login & Management APIs

From Social ID Developers
(Difference between revisions)
Jump to: navigation, search
(→Sign ins)
 
(15 intermediate revisions by 3 users not shown)
Line 2: Line 2:
  
 
{|
 
{|
−
! align="left" width="300px"| Resource
+
! align="left" width="400px"| Resource
 
! align="left"| Description
 
! align="left"| Description
 
|-
 
|-
 
| [[GET login/info]]
 
| [[GET login/info]]
−
| Validates the token given to the callback_url and returns social login information.  
+
| Validates the token given to the callback_url and returns login information.  
 
|}
 
|}
  
Line 12: Line 12:
  
 
{|
 
{|
−
! align="left" width="300px"| Resource
+
! align="left" width="400px"| Resource
 
! align="left"| Description
 
! align="left"| Description
 
|-
 
|-
Line 28: Line 28:
  
 
{|
 
{|
−
! align="left" width="300px"| Resource
+
! align="left" width="400px"| Resource
 
! align="left"| Description
 
! align="left"| Description
 
|-
 
|-
Line 49: Line 49:
  
 
{|
 
{|
−
! align="left" width="300px"| Resource
+
! align="left" width="400px"| Resource
 
! align="left"| Description
 
! align="left"| Description
 
|-
 
|-
 
| [[GET login/users]]
 
| [[GET login/users]]
−
| Returns all users or searches for login app users.
+
| Returns all users or searches for users.
 
|-
 
|-
 
| [[GET login/users/:user_id]]
 
| [[GET login/users/:user_id]]
Line 96: Line 96:
 
| [[POST 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.
 
| Sends a reset password e-mail for a user given its username or e-mail.
−
 
 
|-
 
|-
 
| [[POST login/users/reset_password/token]]
 
| [[POST login/users/reset_password/token]]
Line 104: Line 103:
 
| Resets the password for a user given a reset password token.
 
| Resets the password for a user given a reset password token.
 
|-
 
|-
−
| [[POST login/users/send_email_confirmation]]
+
| [[POST login/users/email_confirmation/email]]
 
| Sends an e-mail confirmation for a user given its username or e-mail.
 
| Sends an e-mail confirmation for a user given its username or e-mail.
 +
|-
 +
| [[POST login/users/email_confirmation/token]]
 +
| Creates an e-mail confirmation token for a user given its username or e-mail.
 +
|}
 +
 +
== Credentials ==
 +
 +
{|
 +
! align="left" width="400px"| Resource
 +
! align="left"| Description
 +
|-
 +
| [[GET login/users/:user_id/credentials]]
 +
| Returns all User's credential.
 +
|-
 +
| [[POST login/users/:user_id/credentials/:provider]]
 +
| Add a Social App credential to a User.
 +
|-
 +
| [[DELETE login/users/:user_id/credentials/:provider]]
 +
| Removes a Social App credential from a User.
 +
|}
 +
 +
== User Data ==
 +
 +
{|
 +
! align="left" width="400px"| Resource
 +
! align="left"| Description
 +
|-
 +
| [[GET login/users/:user_id/data]]
 +
| Returns user custom profile information.
 +
|-
 +
| [[PUT login/users/:user_id/data]]
 +
| Updates user custom profile information.
 
|}
 
|}
  
Line 111: Line 142:
  
 
{|
 
{|
−
! align="left" width="300px"| Resource
+
! align="left" width="400px"| Resource
 
! align="left"| Description
 
! align="left"| Description
 
|-
 
|-
Line 127: Line 158:
  
 
{|
 
{|
−
! align="left" width="300px"| Resource
+
! align="left" width="400px"| Resource
 
! align="left"| Description
 
! align="left"| Description
 
|-
 
|-
Line 140: Line 171:
  
 
{|
 
{|
−
! align="left" width="300px"| Resource
+
! align="left" width="400px"| Resource
 
! align="left"| Description
 
! align="left"| Description
 
|-
 
|-
Line 150: Line 181:
  
 
{|
 
{|
−
! align="left" width="300px"| Resource
+
! align="left" width="400px"| Resource
 
! align="left"| Description
 
! align="left"| Description
 
|-
 
|-
 
| [[GET login/apps/social_apps]]
 
| [[GET login/apps/social_apps]]
−
| Returns all Social Apps from the Social Login App.
+
| Returns all Social Apps from the Login App.
 
|}
 
|}
 +
<!--
  
−
== User Data ==
+
== Login Apps ==
  
 
{|
 
{|
−
! align="left" width="300px"| Resource
+
! align="left" width="400px"| Resource
 
! align="left"| Description
 
! align="left"| Description
 
|-
 
|-
−
| [[GET login/users/:user_id/data]]
+
| [[GET login/apps/search]]
−
| Returns user custom profile information.
+
| Searches for Login Apps.
−
|-
+
−
| [[PUT login/users/:user_id/data]]
+
−
| Updates user custom profile information.
+
 
|}
 
|}
  
 +
-->
 
== Clustering ==
 
== Clustering ==
  
 
{|
 
{|
−
! align="left" width="300px"| Resource
+
! align="left" width="400px"| Resource
 
! align="left"| Description
 
! align="left"| Description
 
|-
 
|-
Line 185: Line 215:
 
| Returns user clustering features.
 
| Returns user clustering features.
 
|}
 
|}
 +
 +
== User Groups ==
 +
 +
{|
 +
! align="left" width="400px"| Resource
 +
! align="left"| Description
 +
|-
 +
| [[GET login/users/:user_id/groups]]
 +
| Searches for Groups of a User.
 +
|}
 +
 +
== User Roles ==
 +
 +
{|
 +
! align="left" width="400px"| Resource
 +
! align="left"| Description
 +
|-
 +
| [[GET login/users/:user_id/roles]]
 +
| Searches for Roles of a User.
 +
|}
 +
<!--
 +
 +
== User Reviewable Access Requests ==
 +
 +
{|
 +
! align="left" width="400px"| Resource
 +
! align="left"| Description
 +
|-
 +
| [[GET login/users/:user_id/user_reviewable_access_requests]]
 +
| Searches for Reviewable Access Requests of a User.
 +
|}
 +
 +
== User Authorized Login Apps ==
 +
 +
{|
 +
! align="left" width="400px"| Resource
 +
! align="left"| Description
 +
|-
 +
| [[GET login/users/:user_id/user_authorized_apps]]
 +
| Searches for Authorized Login Apps of a User.
 +
|}
 +
 +
-->

Latest revision as of 01:07, 11 August 2023

Contents

Info

Resource Description
GET login/info Validates the token given to the callback_url and returns 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 a user_id.
POST login/apps/:app_id/sign_ins/:provider Creates a new sign_in given a provider credential.

Connections

Resource Description
DELETE login/connections/:id Closes a connection (logout).
POST login/connections/:id Keeps the connection alive.
GET login/connections/:id Returns connection information.

Users

Resource Description
GET login/users Returns all users or searches for users.
GET login/users/:user_id Returns user information, including his/her 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 another user and then removes user.
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 a user.
POST login/users/:user_id/touch Force User to be updated.
DELETE login/users/:user_id Deletes a user.
GET login/users/find_by Finds a user by username, e-mail or reset password token
POST login/users/login Creates a sign in for a user given its password and username or e-mail.
PUT login/users/:user_id/activate Activates a user for login.
PUT login/users/:user_id/deactivate Deactivates a user for login.
PUT login/users/:user_id/unlock Unlocks a user for login.
POST login/users/reset_password/email Sends a reset password e-mail for a user given its username or e-mail.
POST login/users/reset_password/token Creates a reset password token for a user given its username or e-mail.
POST login/users/reset_password Resets the password for a user given a reset password token.
POST login/users/email_confirmation/email Sends an e-mail confirmation for a user given its username or e-mail.
POST login/users/email_confirmation/token Creates an e-mail confirmation token for a user given its username or e-mail.

Credentials

Resource Description
GET login/users/:user_id/credentials Returns all User's credential.
POST login/users/:user_id/credentials/:provider Add a Social App credential to a User.
DELETE login/users/:user_id/credentials/:provider Removes a Social App credential from a User.

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.

Facebook

Resource Description
POST login/users/:user_id/updates/facebook Posts a message to the user Facebook timeline.
POST login/users/:user_id/notifications/facebook Posts a Facebook notification to the user.
GET login/users/:user_id/friends/facebook Get Facebook user friends.

User Mac Address

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

User MPact Client

Resource Description
POST login/users/:user_id/mpact_client_ids Creates a new MPact client associated with a user.

Social Apps

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

Clustering

Resource Description
GET login/apps/clustering/rules Returns login app clustering rules.
PUT login/apps/clustering/rules Updates login app clustering rules.
GET login/users/:user_id/clustering/features Returns user clustering features.

User Groups

Resource Description
GET login/users/:user_id/groups Searches for Groups of a User.

User Roles

Resource Description
GET login/users/:user_id/roles Searches for Roles of a User.
Retrieved from "https://dev.socialidnow.com/index.php?title=Login_%26_Management_APIs&oldid=3562"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox