{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance/user/auth/:backend/","auth":"required","examples":{"codes":[{"name":"","code":"curl -X POST \\\n-H \"X-API-KEY: <API_KEY>\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"access_token\": \"<BACKEND_PROVIDER_TOKEN>\"}' \\\n\"https://api.syncano.io/v1.1/instances/<instance>/user/auth/<backend_name>/\"","language":"curl"},{"language":"python","code":"// Coming soon"},{"language":"javascript","code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({apiKey: \"API_KEY\"});\nvar User = connection.User;\n\nvar query = {instanceName: \"INSTANCE_NAME\", backend: \"facebook\"};\nvar credentials = {access_token: \"TOKEN\"};\n\nUser.please().socialLogin(query, credentials).then(callback);"}]},"method":"post","params":[{"name":"instance","type":"string","default":"","desc":"Instance name","required":true,"in":"path","ref":"","_id":"551d39773c66970d00d20bd2"},{"name":"backend","type":"string","default":"","desc":"Social authentication backend. 'facebook', 'google-oauth2', 'twitter' and 'linkedin' are the available ones","required":true,"in":"path","ref":"","_id":"551d40ed1bf7163700418247"},{"name":"access_token","type":"string","default":"","desc":"Social backend token, received from one of the platforms we support ('facebook' and 'google-oauth2')","required":true,"in":"body","ref":"","_id":"563162b9fa40240d007c8c92"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"username\": \"user_14254712144338013_0\",\n    \"user_key\": \"b22f9dd4za1b02152455f3820326e91322b50f96\",\n    \"profile\": {\n        \"channel_room\": null,\n        \"group\": null,\n        \"links\": {\n            \"owner\": \"/v1.1/instances/instance/users/5/\"\n        },\n        \"group_permissions\": \"none\",\n        \"created_at\": \"2015-06-09T14:23:39.090423Z\",\n        \"owner_permissions\": \"full\",\n        \"updated_at\": \"2015-06-09T14:23:39.090451Z\",\n        \"id\": 15,\n        \"avatar\": null,\n        \"owner\": 5,\n        \"other_permissions\": \"none\",\n        \"channel\": null,\n        \"revision\": 1\n    },\n    \"id\": 5,\n    \"links\": {\n        \"self\": \"/v1.1/instances/instance/users/5/\",\n        \"reset-key\": \"/v1.1/instances/instance/users/5/reset_key/\",\n        \"groups\": \"/v1.1/instances/instance/users/5/groups/\"\n    }\n}","name":""},{"language":"json","code":"{\n    \"detail\": \"Invalid username or password.\"\n}","name":"","status":401}]},"settings":"56c50c06d1b8770d00922288"},"next":{"description":"","pages":[]},"title":"User - social log in","type":"endpoint","slug":"user-log-in-via-social","excerpt":"","body":"Method for logging in your application users via social sign up. A log in with a social service will create a new user. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"* facebook\\n* google-oauth2\\n* twitter\\n* linkedin\",\n  \"title\": \"Supported backend names\"\n}\n[/block]","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50632bdcde80d004986b3","__v":0,"editedParams":true,"project":"54774d9af3736008009e9e0e","createdAt":"2015-04-02T13:15:25.535Z","githubsync":"","user":"54774c47f3736008009e9e0c","version":{"version":"0.1.1","version_clean":"0.1.1","codename":"API v1.1","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":true,"categories":["56c50628bdcde80d00498636","56c50628bdcde80d00498637","56c50628bdcde80d00498638","56c50628bdcde80d00498639","56c50628bdcde80d0049863a","56c50628bdcde80d0049863b","56c50628bdcde80d0049863c","56c50628bdcde80d0049863d","56c50628bdcde80d0049863e","56c50628bdcde80d0049863f","56c50628bdcde80d00498640","56c50628bdcde80d00498641","56c50628bdcde80d00498642","56c50628bdcde80d00498643","56c50628bdcde80d00498644","56c50628bdcde80d00498645","56c50628bdcde80d00498646","56c50628bdcde80d00498647","56c506a018f0c90d002808de","56c6b0baf795cf0d003ec13e","56fe58eb5a08190e00085149","571764513cf2960e0009a635","571fc008ffbc6a2000b25bb5","5739ca371f4b740e00b06e09","577522f197a3830e004bcc1b","57753d5ffecd260e00d86ce6","57adb71efaa7a10e004495b6"],"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z"},"editedParams2":true,"category":{"sync":{"isSync":false,"url":""},"pages":["56c50632bdcde80d004986b2","56c50632bdcde80d004986b3","56c50632bdcde80d004986b4","56c50632bdcde80d004986b5","56c50632bdcde80d004986b6"],"title":"User","slug":"user","order":16,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d00498644","createdAt":"2015-04-02T12:24:37.714Z","project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635","__v":1},"parentDoc":null}

postUser - social log in


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance:
required
string
Instance name
backend:
required
string
Social authentication backend. 'facebook', 'google-oauth2', 'twitter' and 'linkedin' are the available ones

Body Params

access_token:
required
string
Social backend token, received from one of the platforms we support ('facebook' and 'google-oauth2')

Examples


Result Format


Documentation

Method for logging in your application users via social sign up. A log in with a social service will create a new user. [block:callout] { "type": "info", "body": "* facebook\n* google-oauth2\n* twitter\n* linkedin", "title": "Supported backend names" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}