{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/user/?user_key=:user_key","auth":"required","settings":"","examples":{"codes":[{"language":"curl","name":"","code":"curl -X GET \\\n-H \"X-API-KEY: <API_KEY>\" \\\n-H \"X-USER-KEY: <USER_KEY>\" \\\n-H \"Content-Type: application/json\" \\\n\"https://api.syncano.io/v1.1/instances/rivia/user/\""},{"code":"import syncano\nfrom syncano.models import User\n\nsyncano.connect(api_key=\"API_KEY\", user_key=\"USER_KEY\", instance_name=\"INSTANCE_NAME\") \n\nuser = User.please.get(id=USER_ID)\n\nprint(user.username)\n","language":"python"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({userKey: \"USER_KEY\", apiKey: \"API_KEY\"});\nvar User = connection.User;\n\nUser.please().get({instanceName: \"INSTANCE_NAME\"}).then(callback);","language":"javascript"}]},"method":"get","params":[{"name":"instance_name","type":"string","default":"","desc":"Instance name","required":true,"in":"path","ref":"","_id":"551d39773c66970d00d20bd2"},{"name":"user_key","type":"string","default":"","desc":"User API Key.","required":true,"in":"path","ref":"","_id":"551d3ca9b2a89a230058ad64"}],"results":{"codes":[{"name":"","code":"{\n  \"username\": \"geralt\",\n  \"profile\": {\n    \"channel_room\": null,\n    \"group\": null,\n    \"links\": {\n      \"owner\": \"/v1.1/instances/rivia/users/1/\",\n      \"self\": \"/v1.1/instances/rivia/classes/user_profile/objects/1/\"\n    },\n    \"group_permissions\": \"none\",\n    \"created_at\": \"2015-05-19T15:52:36.183576Z\",\n    \"owner_permissions\": \"full\",\n    \"updated_at\": \"2015-05-19T15:52:36.183608Z\",\n    \"other_permissions\": \"none\",\n    \"owner\": 1,\n    \"id\": 1,\n    \"channel\": null,\n    \"revision\": 1\n  },\n  \"links\": {\n    \"profile\": \"/v1.1/instances/rivia/classes/user_profile/objects/1/\",\n    \"self\": \"/v1.1/instances/rivia/users/1/\",\n    \"groups\": \"/v1.1/instances/rivia/users/1/groups/\",\n    \"reset-key\": \"/v1.1/instances/rivia/users/1/reset_key/\"\n  },\n  \"user_key\": \"afd4bf084f71c8e7659e7a3e53e9df762c6fad9a\",\n  \"groups\": [\n    {\n      \"description\": \"\",\n      \"id\": 1,\n      \"links\": {\n        \"self\": \"/v1.1/instances/rivia/groups/1/\",\n        \"users\": \"/v1.1/instances/rivia/groups/1/users/\"\n      },\n      \"label\": \"witchers\"\n    }\n  ],\n  \"id\": 1\n}","language":"json","status":200},{"status":403,"language":"json","code":"{\n  \"detail\": \"You do not have permission to perform this action.\"\n}"},{"status":404,"language":"json","code":"{\n  \"detail\": \"Instance was not found.\"\n}"}]}},"next":{"description":"","pages":[]},"title":"User - details","type":"endpoint","slug":"user-details","excerpt":"","body":"Get details of your application user.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"This endpoint will work only in combination of Instance API Key and User Key. \\nTrying to use Account Key will give 403 response `{\\\"detail\\\": \\\"You do not have permission to perform this action.\\\"}`\",\n  \"title\": \"API Key vs Account Key\"\n}\n[/block]","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50632bdcde80d004986b4","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"},"createdAt":"2015-04-02T12:57:13.425Z","parentDoc":null,"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},"githubsync":"","project":"54774d9af3736008009e9e0e","__v":0,"editedParams":true,"editedParams2":true}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name
user_key:
required
string
User API Key.

Examples


Result Format


Documentation

Get details of your application user. [block:callout] { "type": "warning", "body": "This endpoint will work only in combination of Instance API Key and User Key. \nTrying to use Account Key will give 403 response `{\"detail\": \"You do not have permission to perform this action.\"}`", "title": "API Key vs Account Key" } [/block]

User Information

Try It Out

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