{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/Groups","auth":"required","settings":"5b6af66fa7e2580003fb7cbd","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"displayName\": \"Test Group\",\n    \"id\": 15,\n    \"members\": [\n        {\n            \"display\": \"TestFirst TestLast\",\n            \"primary\": null,\n            \"type\": null,\n            \"value\": 46\n        }\n    ],\n    \"meta\": {\n        \"created\": \"2018-01-01 00:00:00\",\n        \"lastModified\": null,\n        \"location\": \"https://www.formstack.com/scim/Groups/15\",\n        \"resourceType\": \"Group\"\n    },\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n    ]\n}","name":""},{"status":400,"language":"json","code":"{\n    \"detail\": \"Invalid input\",\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:Error\"\n    ],\n    \"scimType\": null,\n    \"status\": 400\n}","name":""}]},"examples":{"codes":[]},"method":"post","params":[{"name":"displayName","type":"string","default":"","desc":"Name for the group. If one is not specified, one will be generated.","required":false,"in":"body","ref":"","_id":"5b6c4a8f4dc28d0003b5df4c"},{"name":"members","type":"array_object","default":"[{\"value\":46}]","desc":"Array of MultiValueAttribute objects with the value being the user ID.","required":false,"in":"body","ref":"","_id":"5b6c4a8f4dc28d0003b5df4b"},{"name":"id","type":"int","default":"","desc":"Group ID","required":false,"in":"path","ref":"","_id":"5b6c4abbb02563000334ed61"}]},"next":{"description":"","pages":[]},"title":"/Groups","type":"endpoint","slug":"groups-1","excerpt":"","body":"The request is a [Group](models#section-group) object.\n\nThe response is a [Group](models#section-group) object.","updates":[],"order":12,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b6b3c24e0d97f000309447e","project":"543469460ef9c00800164f0e","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54346a2b0ef9c00800164f29","543473445b10711400c6c21a","543473500ef9c00800164fde","54347c625b10711400c6c301","5434918d0ef9c008001651ff","5434b72c008ec22200d86ae7","5435990c495d5d0800f3a510","5b6af3dffc81e4000383db74"],"_id":"54346a2a0ef9c00800164f28","releaseDate":"2014-10-07T22:33:14.982Z","createdAt":"2014-10-07T22:33:14.982Z","forked_from":"543469460ef9c00800164f11","project":"543469460ef9c00800164f0e","__v":8},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"SCIM","slug":"scim","order":3,"from_sync":false,"reference":false,"_id":"5b6af3dffc81e4000383db74","project":"543469460ef9c00800164f0e","version":"54346a2a0ef9c00800164f28","createdAt":"2018-08-08T13:45:03.252Z","__v":0},"user":"58c99a66fa6c4b0f0031a912","createdAt":"2018-08-08T18:53:24.064Z","__v":6,"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
integer
Group ID

Body Params

displayName:
string
Name for the group. If one is not specified, one will be generated.
members:
array of objects[{"value":46}]
Array of MultiValueAttribute objects with the value being the user ID.

Result Format


Documentation

The request is a [Group](models#section-group) object. The response is a [Group](models#section-group) object.

User Information

Try It Out

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