{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance/admins/:admin_id/","auth":"required","examples":{"codes":[{"name":"","code":"curl -X PATCH \\\n-H \"X-API-KEY: <ACCOUNT_KEY>\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"role\":\"full\"}' \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/admins/<admin_id>/\"","language":"curl"},{"code":"import syncano\nfrom syncano.models import Admin\n\nsycano.connect(api_key='your_api_key', instance_name=\"INSTANCE_NAME\")\n\nAdmin.please.update(id=8, role=\"read\")\n","language":"python"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar Admin = connection.Admin;\n\nvar query = {instanceName: \"INSTANCE_NAME\", id: 7};\nvar update = {\"role\":\"full\"};\n\nAdmin.please().update(query, update).then(callback);","language":"javascript"}]},"method":"patch","params":[{"name":"instance","type":"string","default":"","desc":"Instance name","required":true,"in":"path","ref":"","_id":"54d8b350628f540d00f3e4ae"},{"name":"admin_id","type":"string","default":"","desc":"Admin ID","required":true,"in":"path","ref":"","_id":"54db5c526824b22100b3ea95"},{"name":"Admin role","type":"string","default":"","desc":"Admin role. Can be be on of: `full`, `write`, `read`.","required":false,"in":"body","ref":"","_id":"54dc7e6104fd850d0014c5ad"}],"results":{"codes":[{"name":"","code":"{\n  \"first_name\": \"Meve\",\n  \"last_name\": \"Of Lyria and Rivia\",\n  \"links\": {\n    \"self\": \"/v1.1/instances/rivia/admins/8/\"\n  },\n  \"email\": \"meve:::at:::lyria-and-rivia.com\",\n  \"role\": \"full\",\n  \"id\": 8\n}","language":"json","status":200},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json","status":403},{"code":"{\n  \"detail\": \"Not found\"\n}","language":"json","status":404}]},"settings":"56c50c06d1b8770d00922288"},"next":{"description":"","pages":[]},"title":"Administrator - update","type":"endpoint","slug":"admins-update-patch","excerpt":"","body":"Updates an admin (by changing their role).\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Roles\",\n  \"body\": \"Available admin roles are: \\n- `full` - has read and write access to all the instance data, can add administrators,\\n- `read` - has read and write access to all the instance data, cannot add administrators, \\n- `write` - has read and write access to all the instance data (cannot modify it), cannot add administrators\\n\\nYou can learn more about Admin roles in the [Administrators chapter](http://docs.syncano.com/docs/administrators).\"\n}\n[/block]\nAdmins can be invited to an Instance with a POST method to the [/instances/:instance/invitations/](invitations-add) endpoint.","updates":[],"order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50631bdcde80d004986ab","__v":0,"editedParams":true,"editedParams2":true,"project":"54774d9af3736008009e9e0e","category":{"sync":{"isSync":false,"url":""},"pages":["56c50631bdcde80d004986a8","56c50631bdcde80d004986a9","56c50631bdcde80d004986aa","56c50631bdcde80d004986ab","56c50631bdcde80d004986ac"],"title":"Administrators","slug":"administrators","order":10,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d0049863e","project":"54774d9af3736008009e9e0e","__v":1,"createdAt":"2015-03-17T14:18:28.079Z","version":"56c50626bdcde80d00498635"},"user":"54774c47f3736008009e9e0c","createdAt":"2015-02-12T10:07:04.047Z","githubsync":"","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"},"parentDoc":null}

patchAdministrator - update


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance:
required
string
Instance name
admin_id:
required
string
Admin ID

Body Params

Admin:
string
Admin role. Can be be on of: `full`, `write`, `read`.

Examples


Result Format


Documentation

Updates an admin (by changing their role). [block:callout] { "type": "info", "title": "Roles", "body": "Available admin roles are: \n- `full` - has read and write access to all the instance data, can add administrators,\n- `read` - has read and write access to all the instance data, cannot add administrators, \n- `write` - has read and write access to all the instance data (cannot modify it), cannot add administrators\n\nYou can learn more about Admin roles in the [Administrators chapter](http://docs.syncano.com/docs/administrators)." } [/block] Admins can be invited to an Instance with a POST method to the [/instances/:instance/invitations/](invitations-add) endpoint.

User Information

Try It Out

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