{"_id":"5b6b3c62087afa000352eb60","project":"543469460ef9c00800164f0e","version":{"_id":"54346a2a0ef9c00800164f28","forked_from":"543469460ef9c00800164f11","project":"543469460ef9c00800164f0e","__v":8,"createdAt":"2014-10-07T22:33:14.982Z","releaseDate":"2014-10-07T22:33:14.982Z","categories":["54346a2b0ef9c00800164f29","543473445b10711400c6c21a","543473500ef9c00800164fde","54347c625b10711400c6c301","5434918d0ef9c008001651ff","5434b72c008ec22200d86ae7","5435990c495d5d0800f3a510","5b6af3dffc81e4000383db74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"5b6af3dffc81e4000383db74","project":"543469460ef9c00800164f0e","version":"54346a2a0ef9c00800164f28","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-08-08T13:45:03.252Z","from_sync":false,"order":3,"slug":"scim","title":"SCIM"},"user":"58c99a66fa6c4b0f0031a912","__v":7,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-08-08T18:54:26.373Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"5b6af66fa7e2580003fb7cbd","results":{"codes":[{"name":"","code":"{\n \"displayName\": \"Test Group\",\n \"urn:ietf:params:scim:schemas:extension:formstack:2.0:Group\": {\n \"folders\": [\n {\n \"id\": \"4\",\n \"meta\": {\n \"created\": null,\n \"lastModified\": null,\n \"location\": \"https://www.formstack.com/scim/Folders/4\",\n \"resourceType\": \"Folder\"\n },\n \"name\": \"zonk\",\n \"parentFolderId\": null,\n \"permissions\": {\n \"canEditSubmissions\": false,\n \"canViewSubmissions\": true,\n \"isAdmin\": false\n },\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:formstack:2.0:Folder\"\n ]\n }\n ],\n \"forms\": [\n {\n \"id\": \"2913490\",\n \"meta\": {\n \"created\": \"2018-02-27 12:10:48\",\n \"lastModified\": null,\n \"location\": \"https://www.formstack.com/scim/Forms/2913490\",\n \"resourceType\": \"Form\"\n },\n \"name\": \"Test Form\",\n \"permissions\": {\n \"canEditSubmissions\": false,\n \"canViewSubmissions\": true,\n \"isAdmin\": false\n },\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:formstack:2.0:Form\"\n ]\n }\n ]\n },\n \"id\": \"5\",\n \"members\": [\n {\n \"display\": \"TestFirst TestLast\",\n \"primary\": null,\n \"type\": null,\n \"value\": 46\n }\n ],\n \"meta\": {\n \"created\": \"2018-06-22 14:33:11\",\n \"lastModified\": null,\n \"location\": \"https://www.formstack.com/scim/Groups/5\",\n \"resourceType\": \"Group\"\n },\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:Group\",\n \"urn:ietf:params:scim:schemas:extension:formstack:2.0:Group\"\n ]\n}\n","language":"json","status":200},{"name":"","code":"{\n \"detail\": \"Not Found\",\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:Error\"\n ],\n \"scimType\": null,\n \"status\": 404\n}","language":"json","status":404}]},"examples":{"codes":[]},"method":"patch","auth":"required","params":[{"_id":"5b6c4fbaa59fbe00031d6d84","ref":"","in":"path","required":false,"desc":"Group ID.","default":"","type":"int","name":"id"},{"_id":"5b6c4fbaa59fbe00031d6d83","ref":"","in":"body","required":false,"desc":"Array of PatchOp objects. The 'path' property can be 'members' 'forms' or 'folders'. With a 'path' of 'members', the 'ops' property can be 'add' or 'remove'. With a 'path' of 'forms' or 'folders', the 'ops' property can be 'read' 'write' or 'none'. The 'value' property is an array of MultiValueAttribute objects. The value will be user ID, form ID, or folder ID based on if the path is 'members', 'forms', or 'folders', respectively. Such as: [{\"op\":\"add\",\"path\":\"members\",\"value\":[{\"value\":46}]},{\"op\":\"remove\",\"path\":\"members\",\"value\":[{\"value\":47}]},{\"op\":\"read\",\"path\":\"forms\",\"value\":[{\"value\":46}]},{\"op\":\"write\",\"path\":\"forms\",\"value\":[{\"value\":47}]},{\"op\":\"admin\",\"path\":\"forms\",\"value\":[{\"value\":48}]}]","default":"[{\"op\":\"add\",\"path\":\"members\",\"value\":[{\"value\":46}]},{\"op\":\"remove\",\"path\":\"members\",\"value\":[{\"value\":47}]},{\"op\":\"read\",\"path\":\"forms\",\"value\":[{\"value\":46}]},{\"op\":\"write\",\"path\":\"forms\",\"value\":[{\"value\":47}]},{\"op\":\"admin\",\"path\":\"forms\",\"value\":[{\"value\":48}]}]","type":"object","name":"Operations"}],"url":"/Groups/:id"},"isReference":false,"order":15,"body":"The request is a [PatchOperations](models#section-patchoperations) object, which includes an array of [PatchOperation](models#section-patchoperation) objects. The only supported `op`s are `add` and `remove` currently for adding and removing users from the group.\n\nThe response is a [Group](models#section-group) object.","excerpt":"","slug":"groupsid-2","type":"endpoint","title":"/Groups/:id"}patch/Groups/:id
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
id:
integer
Group ID.
Body Params
Operations:
object[{"op":"add","path":"members","value":[{"value":46}]},{"op":"remove","path":"members","value":[{"value":47}]},{"op":"read","path":"forms","value":[{"value":46}]},{"op":"write","path":"forms","value":[{"value":47}]},{"op":"admin","path":"forms","value":[{"value":48}]}]
Array of PatchOp objects. The 'path' property can be 'members' 'forms' or 'folders'. With a 'path' of 'members', the 'ops' property can be 'add' or 'remove'. With a 'path' of 'forms' or 'folders', the 'ops' property can be 'read' 'write' or 'none'. The 'value' property is an array of MultiValueAttribute objects. The value will be user ID, form ID, or folder ID based on if the path is 'members', 'forms', or 'folders', respectively. Such as: [{"op":"add","path":"members","value":[{"value":46}]},{"op":"remove","path":"members","value":[{"value":47}]},{"op":"read","path":"forms","value":[{"value":46}]},{"op":"write","path":"forms","value":[{"value":47}]},{"op":"admin","path":"forms","value":[{"value":48}]}]