{"_id":"564de3c11133043500f4bf96","version":{"_id":"563a252d50bf950d00e0979b","__v":7,"project":"563a252d50bf950d00e09798","createdAt":"2015-11-04T15:33:01.701Z","releaseDate":"2015-11-04T15:33:01.701Z","categories":["563a252e50bf950d00e0979c","563a2a691846790d008952fe","563a3394daf1c00d00136d9b","563a3467d25e8919005f3f0c","563a347850bf950d00e097b4","570e5cec10aa423200391fb5","5890d358d6cb8e2500a3f311"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"__v":3,"user":"54c7fdeae317000d007c2765","category":{"_id":"563a252e50bf950d00e0979c","project":"563a252d50bf950d00e09798","pages":["563a252f50bf950d00e0979e","563a35ac1846790d0089532c","563d1407d8f2d20d00448d3c","563d1d3f9799fb0d0004776a","564509aa2c74cf1900da48c7","56453b7e9f3f550d00fa3c7b","564b498aeed7de0d003672c3","564b523ce5d9d61700d580e0","564b58ea1a8e610d006bfd49","564b59baee12850d00958656","564b6773d969330d00aba984","564b69b2d7b95d0d00ed050f","564b7fa8cc472d0d00da9447","564b905fa8a0ba21002ad6b1","564ba051288b1a2b00b3ae83","564ba6275cc43717009bcff1","564bb2138841060d00abb2e0","564bb74e05c99e1700161dd1","564c8ad60ddedc210051e582","564cca42d0c5b42b002305e8","564cca8ecfa4452b0019926d","564ce34f404ce53500fdb255","564cea76404ce53500fdb272","564cedb77d4d31170028dd2e","564cefc1bc81632100b10468","564cf17d1f42792b00820515","564cf5462248461700bd4017","564ddd49a8671617004e7b90","564ddf9ead1d5217003e2e18","564de1dea8671617004e7b99","564de3c11133043500f4bf96","564de669e39c4435005a1f65","564df3f16eaa3a2100868961","5655d3519347d30d00d7e8e2"],"version":"563a252d50bf950d00e0979b","__v":34,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-04T15:33:02.244Z","from_sync":false,"order":9999,"slug":"documentation","title":"Documentation"},"project":"563a252d50bf950d00e09798","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-19T14:59:13.712Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":39,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /users/{id}/roles\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description \\nPermissions\\nResource URL \\nParameters  \\nResponse codes\",\n    \"0-1\": \"Get a list of the user’s roles.\\nuser.manage\\nhttps://app.klipfolio.com/api/1.0/users/{id}/roles\\nuser id={id}\\n401 — access denied\\n404 — user id not found\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"user.manage\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/users/{id}/roles\",\n    \"3-1\": \"user id={id}\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`GET https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/roles`\n\n##Example Response\n```\n{\n \"data\": {\n       \"id\":\"fedcba9876543210fedcba9876543210\",\n       \"name\":\"Admin\",\n       \"description\":\"Manage all assets, users, groups, roles, and account settings.\"\n  },\n \"meta\": {\n     \"status\": 200,\n     \"success\": true\n }\n}\n```\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"PUT /users/{id}/roles/{id}\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Assign a user to a role.\",\n    \"1-1\": \"user.manage\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/users/{id}/roles/{id}\",\n    \"3-1\": \"user id={id}, roles id={id}\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`PUT https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/roles/abcdef123456 -d “{'id': ['f70a1cd9817b85ffa252a7b4280f0223’]}”`\n\n##Example Response\n```\n{\n  \"meta\": {\n     \"status\": 200,\n     \"success\": true\n }\n}\n```\n\n[block:api-header]\n{\n  \"type\": \"delete\",\n  \"title\": \"DELETE /users/{id}/roles/{id}\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Delete the user from a specified role.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"user.manage\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/users/{id}/roles{roleid}\",\n    \"3-1\": \"None.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`DELETE https://app.klipfolio.com/api/1/users/0123456789abc/roles/0123456789abdef0123456789abcdef`\n###Example Response\n```\n{\n\"meta\": {\n      \"status\": 200,\n      \"success\": true\n  }\n}\n```","excerpt":"View, update and manage user roles.","slug":"user-roles","type":"basic","title":"User Roles"}

User Roles

View, update and manage user roles.

[block:api-header] { "type": "get", "title": "GET /users/{id}/roles" } [/block] [block:parameters] { "data": { "0-0": "Description \nPermissions\nResource URL \nParameters \nResponse codes", "0-1": "Get a list of the user’s roles.\nuser.manage\nhttps://app.klipfolio.com/api/1.0/users/{id}/roles\nuser id={id}\n401 — access denied\n404 — user id not found", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "user.manage", "2-1": "https://app.klipfolio.com/api/1.0/users/{id}/roles", "3-1": "user id={id}" }, "cols": 2, "rows": 4 } [/block] ##Example Request `GET https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/roles` ##Example Response ``` { "data": { "id":"fedcba9876543210fedcba9876543210", "name":"Admin", "description":"Manage all assets, users, groups, roles, and account settings." }, "meta": { "status": 200, "success": true } } ``` [block:api-header] { "type": "put", "title": "PUT /users/{id}/roles/{id}" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Assign a user to a role.", "1-1": "user.manage", "2-1": "https://app.klipfolio.com/api/1.0/users/{id}/roles/{id}", "3-1": "user id={id}, roles id={id}", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters" }, "cols": 2, "rows": 4 } [/block] ##Example Request `PUT https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/roles/abcdef123456 -d “{'id': ['f70a1cd9817b85ffa252a7b4280f0223’]}”` ##Example Response ``` { "meta": { "status": 200, "success": true } } ``` [block:api-header] { "type": "delete", "title": "DELETE /users/{id}/roles/{id}" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Delete the user from a specified role.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "user.manage", "2-1": "https://app.klipfolio.com/api/1.0/users/{id}/roles{roleid}", "3-1": "None." }, "cols": 2, "rows": 4 } [/block] ##Example Request `DELETE https://app.klipfolio.com/api/1/users/0123456789abc/roles/0123456789abdef0123456789abcdef` ###Example Response ``` { "meta": { "status": 200, "success": true } } ```