{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/users/","auth":"required","examples":{"codes":[{"name":"","code":"curl -X GET \\\n-H \"X-API-KEY: <API_KEY>\" \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/users/\"","language":"curl"},{"code":"import syncano\nfrom syncano.models import User\n\nsyncano.connect(api_key='API_KEY', instance_name='INSTANCE_NAME')\nusers = User.please.list()\nfor user in users:\n    print(user.user_key)\n    # or: print(user)","language":"python"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({apiKey: \"API_KEY\"});\nvar User = connection.User;\n\nUser.please().list({instanceName: \"INSTANCE_NAME\"}).then(callback);","language":"javascript"}]},"method":"get","params":[{"name":"instance_name","type":"string","default":"","desc":"Name of the instance that the application users belong to.","required":true,"in":"path","ref":"","_id":"552e06b95d4baa0d007835ee"}],"results":{"codes":[{"name":"","code":"{\n  \"prev\": null,\n  \"objects\": [\n    {\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\": \"12h46d960dbf3ec62da2dea6bcasd1aade6sqv24388\",\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    },\n    {\n      \"username\": \"ciri\",\n      \"profile\": {\n        \"channel_room\": null,\n        \"group\": null,\n        \"links\": {\n          \"owner\": \"/v1.1/instances/rivia/users/2/\",\n          \"self\": \"/v1.1/instances/rivia/classes/user_profile/objects/2/\"\n        },\n        \"group_permissions\": \"none\",\n        \"created_at\": \"2015-05-19T16:32:42.414213Z\",\n        \"owner_permissions\": \"full\",\n        \"updated_at\": \"2015-05-19T16:32:42.414241Z\",\n        \"other_permissions\": \"none\",\n        \"owner\": 2,\n        \"id\": 2,\n        \"channel\": null,\n        \"revision\": 1\n      },\n      \"links\": {\n        \"profile\": \"/v1.1/instances/rivia/classes/user_profile/objects/2/\",\n        \"self\": \"/v1.1/instances/rivia/users/2/\",\n        \"groups\": \"/v1.1/instances/rivia/users/2/groups/\",\n        \"reset-key\": \"/v1.1/instances/rivia/users/2/reset_key/\"\n      },\n      \"user_key\": \"12h46d960dbf3ec62da2dea6bcasd1aade6sqv24388\",\n      \"groups\": [],\n      \"id\": 2\n    },\n    {\n      \"username\": \"triss\",\n      \"profile\": {\n        \"channel_room\": null,\n        \"group\": null,\n        \"links\": {\n          \"owner\": \"/v1.1/instances/rivia/users/3/\",\n          \"self\": \"/v1.1/instances/rivia/classes/user_profile/objects/6/\"\n        },\n        \"group_permissions\": \"none\",\n        \"created_at\": \"2015-05-19T16:40:08.804304Z\",\n        \"owner_permissions\": \"full\",\n        \"updated_at\": \"2015-05-19T16:40:08.804334Z\",\n        \"other_permissions\": \"none\",\n        \"owner\": 3,\n        \"id\": 6,\n        \"channel\": null,\n        \"revision\": 1\n      },\n      \"links\": {\n        \"profile\": \"/v1.1/instances/rivia/classes/user_profile/objects/6/\",\n        \"self\": \"/v1.1/instances/rivia/users/3/\",\n        \"groups\": \"/v1.1/instances/rivia/users/3/groups/\",\n        \"reset-key\": \"/v1.1/instances/rivia/users/3/reset_key/\"\n      },\n      \"user_key\": \"12h46d960dbf3ec62da2dea6bcasd1aade6sqv24388\",\n      \"groups\": [],\n      \"id\": 3\n    }\n  ],\n  \"next\": null\n}","language":"json","status":200},{"language":"json","status":403,"code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"code":"{\n  \"detail\": \"Instance was not found.\"\n}","language":"json","status":404}]},"settings":"56c50c06d1b8770d00922288"},"next":{"description":"","pages":[]},"title":"Users - list","type":"endpoint","slug":"users-list","excerpt":"List all users inside the instance. Can be used only with an Account Key (Admin access).","body":"List users that belong to a given instance.","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50634bdcde80d004986c0","editedParams":true,"project":"54774d9af3736008009e9e0e","__v":0,"githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":["56c50634bdcde80d004986c0","56c50634bdcde80d004986c1","56c50634bdcde80d004986c2","56c50634bdcde80d004986c3","56c50634bdcde80d004986c4","56c50634bdcde80d004986c5","56c50634bdcde80d004986c6","56c50634bdcde80d004986c7","56c50634bdcde80d004986c8","56c50634bdcde80d004986c9","56c50634bdcde80d004986ca"],"title":"Users","slug":"users","order":14,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d00498642","project":"54774d9af3736008009e9e0e","__v":1,"createdAt":"2015-04-15T06:31:05.605Z","version":"56c50626bdcde80d00498635"},"createdAt":"2015-04-15T06:35:37.919Z","parentDoc":null,"editedParams2":true,"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"}}

getUsers - list

List all users inside the instance. Can be used only with an Account Key (Admin access).

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Name of the instance that the application users belong to.

Examples


Result Format


Documentation

List users that belong to a given instance.

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 }}