{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/Users","auth":"required","method":"post","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n    \"active\": true,\n    \"emails\": [\n        {\n            \"display\": null,\n            \"primary\": false,\n            \"type\": null,\n            \"value\": \"testscim:::at:::example.com\"\n        }\n    ],\n    \"urn:ietf:params:scim:schemas:extension:formstack:2.0:User\": {\n        \"canCreateForms\": false,\n        \"canCreateThemes\": false,\n        \"isAdmin\": false\n    },\n    \"groups\": [],\n    \"id\": 46,\n    \"meta\": {\n        \"created\": \"2018-01-01 00:00:00\",\n        \"lastModified\": \"2018-01-01 00:00:00\",\n        \"location\": \"https://www.formstack.com/scim/Users/123\",\n        \"resourceType\": \"User\"\n    },\n    \"name\": {\n        \"familyName\": \"FirstName\",\n        \"formatted\": \"LastName FirstName\",\n        \"givenName\": \"LastName\"\n    },\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:core:2.0:User\",\n        \"urn:ietf:params:scim:schemas:extension:formstack:2.0:User\"\n    ],\n    \"timezone\": \"US/Eastern\",\n    \"userName\": \"[email protected]\"\n}\n","language":"json","status":200},{"name":"","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}","language":"json","status":400}]},"settings":"5b6af66fa7e2580003fb7cbd","params":[{"name":"active","type":"boolean","default":"true","desc":"","required":false,"in":"body","ref":"","_id":"5b6b5d38c523fd0003220697"},{"name":"userName","type":"string","default":"","desc":"Email address","required":false,"in":"body","ref":"","_id":"5b6b659f11aaba0003379a0e"},{"name":"name","type":"object","default":"{\"familyName\":\"FirstName\",\"givenName\":\"LastName\"}","desc":"","required":false,"in":"body","ref":"","_id":"5b6b659f11aaba0003379a0d"},{"name":"urn:ietf:params:scim:schemas:extension:formstack:2.0:User","type":"object","default":"{\"canCreateForms\":false,\"canCreateThemes\":false,\"isAdmin\":false}","desc":"Note: The key is 'urn:ietf:params:scim:schemas:extension:formstack:2.0:User' and this documentation page may not be correctly showing the full key","required":false,"in":"body","ref":"","_id":"5b6b5d38c523fd0003220695"}]},"next":{"description":"","pages":[]},"title":"/Users","type":"endpoint","slug":"users-1","excerpt":"","body":"The request is a [User](models#section-user) object.\n\nThe response is a [User](models#section-user) object.","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b6b3b5a14e36e0003dc3697","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:50:02.746Z","__v":12,"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

active:
booleantrue
userName:
string
Email address
name:
object{"familyName":"FirstName","givenName":"LastName"}
urn:ietf:params:scim:schemas:extension:formstack:2.0:
object{"canCreateForms":false,"canCreateThemes":false,"isAdmin":false}
Note: The key is 'urn:ietf:params:scim:schemas:extension:formstack:2.0:User' and this documentation page may not be correctly showing the full key

Result Format


Documentation

The request is a [User](models#section-user) object. The response is a [User](models#section-user) 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 }}