{"_id":"5c182816f89967005c60a300","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":35,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5","5c351061191e2b002b4988a8","5c8b01b199b56e00440aa018"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c2fb00b2b45c0010b7a3d7","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-20T23:34:24.298Z","from_sync":false,"order":21,"slug":"environments-api","title":"Environments API"},"user":"5a6a26281895510045b2cd40","__v":8,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-12-17T22:49:58.847Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"text","code":"No output.\nResponds with 200 if permissions for the user already exist.","name":""},{"status":201,"language":"text","code":"No output.\nResponds with 201 if the user's permissions had not existed.","name":""},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"path\": \"id\",\n            \"message\": \"invalid id\"\n        }\n    ]\n}","language":"json","name":"Environment Invalid","status":400},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#/roles/2\",\n            \"message\": \"value 'Delet' is not defined in enum\"\n        }\n    ]\n}","language":"json","name":"Roles Invalid","status":400},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#\",\n            \"message\": \"property invalid is used for a schema that does not allow additional properties\"\n        },\n        {\n            \"in\": \"body\",\n            \"path\": \"#\",\n            \"message\": \"required properties are missing: roles\"\n        }\n    ]\n}","language":"json","name":"Body Invalid","status":400},{"code":"Environment with id E5bb0b1318bca7b97212bb3c1 does not exist.","language":"text","name":"Environment Not Found","status":404}]},"settings":"59a75f6e757d030019b85f83","examples":{"codes":[{"code":"PUT https://ioe.droplit.io/api/environments/E5ba39b58e9835392c38e7be1/permissions/C5157bc0653ca70132b2a88c2;demoUser HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n\t\"roles\" : [\n  \t\"Read\", \"Write\", \"Delete\"\n  ]\n}","language":"http"}]},"method":"put","auth":"required","params":[{"_id":"5c1828a60f95a4003e96bf21","ref":"","in":"path","required":true,"desc":"The ID of the environment.","default":"","type":"string","name":"id"},{"_id":"5c1828a60f95a4003e96bf20","ref":"","in":"path","required":true,"desc":"The ID of the user whose permissions are to be updated.","default":"","type":"string","name":"userId"},{"_id":"5c182bec5f7fea004f567a6c","ref":"","in":"body","required":true,"desc":"The list of actions the user will be able to perform on the environment. The specific roles available can be found in the [Permissions](doc:permissions) article.","default":"","type":"array_string","name":"roles"},{"_id":"5c182bec5f7fea004f567a6b","ref":"","in":"header","required":true,"desc":"The user's development authorization token.","default":"","type":"string","name":"authorization"},{"_id":"5c182bec5f7fea004f567a6a","ref":"","in":"header","required":true,"desc":"Specify that the sent data will be a JSON object.","default":"","type":"string","name":"content-type"}],"url":"/:id/permissions/:userId"},"isReference":false,"order":33,"body":"","excerpt":"Create or modify user permissions for an environment.","slug":"update-user-permissions","type":"endpoint","title":"Update permissions."}

putUpdate permissions.

Create or modify user permissions for an environment.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the environment.
userId:
required
string
The ID of the user whose permissions are to be updated.

Body Params

roles:
required
array of strings
The list of actions the user will be able to perform on the environment. The specific roles available can be found in the [Permissions](doc:permissions) article.

Headers

authorization:
required
string
The user's development authorization token.
content-type:
required
string
Specify that the sent data will be a JSON object.

Examples


Result Format


User Information

Try It Out

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