{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"SCIM API","type":"basic","slug":"scim","excerpt":"System for Cross-domain Identity Management (v2.0)","body":"GoFormz supports SCIM, or System for Cross-domain Identity Management, an open standard that allows you to automate user provisioning using a REST API and JSON. The GoFormz SCIM API follows version 2.0 of the SCIM protocol.\n\nFor more information, visit our [ServiceProviderConfigs ](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/ServiceProviderConfigs/GetScimConfigs_V2) endpoint on what is supported.\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Authentication\",\n  \"body\": \"Our SCIM2.0 endpoints support the same [authentication ](https://developers.goformz.com/docs/authentication)protocols as our API.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"User Endpoints\"\n}\n[/block]\nFor additional information on what is supported, visit our [User Schema ](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Schemas/GetScimUserSchema_V2) endpoint.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Purpose\",\n    \"h-1\": \"API\",\n    \"h-2\": \"Notes\",\n    \"h-3\": \"\",\n    \"0-0\": \"[Get Users](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Users/GetScimUsers_V2)\",\n    \"1-0\": \"[Get User Details](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Users/GetScimUserById_V2)\",\n    \"2-0\": \"[Update User](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Users/PutScimUser_V2)\",\n    \"0-1\": \"GET /scim/v2/Users\",\n    \"1-1\": \"GET /scim/v2/Users/{id}\",\n    \"2-1\": \"PUT /scim/v2/Users/{id}\",\n    \"3-0\": \"[Create User](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Users/PostScimUser_V2)\",\n    \"3-1\": \"POST /scim/v2/Users\",\n    \"2-2\": \"Update supported user details:\\n  * Username\\n  * Firstname\\n  * Lastname\\n  * Phone Number\\n  * Password *(optional)*\\n  * Active *(use for deactivating/reactivating a user) *\\nReturns a 200 status code if successful.\",\n    \"0-2\": \"Return a list of users and with a 200 status code if successful.\\n\\nSupports:\\n  * [filtering ](https://developers.goformz.com/docs/filtering)by username, ie. 'username eq {username}'\\n  * pagination\",\n    \"1-2\": \"Returns details of a user with the given {id} and with a 200 status code if successful.\",\n    \"3-2\": \"Password is optional\\n\\nReturns a new user with a 201 status code if successful.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Groups Endpoints\"\n}\n[/block]\nFor additional information on what is supported, visit our [Group Schema ](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Schemas/GetScimGroupSchema_V2) endpoint.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Purpose\",\n    \"h-1\": \"API\",\n    \"h-2\": \"Notes\",\n    \"0-0\": \"[Get Groups (and Members)](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Groups/GetScimGroups_V2)\",\n    \"1-0\": \"[Get Group Details (and Members)](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Groups/GetScimGroupById_V2)\",\n    \"2-0\": \"[Update Group (and Members)](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Groups/PutScimGroup_V2)\",\n    \"3-0\": \"[Create Group](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Groups/PostScimGroup_V2)\",\n    \"4-0\": \"[Delete Group](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Groups/DeleteGroup_V2)\",\n    \"0-1\": \"GET /scim/v2/Groups\",\n    \"1-1\": \"GET /scim/v2/Groups/{id}\",\n    \"2-1\": \"PUT /scim/v2/Groups/{id}\",\n    \"3-1\": \"POST /scim/v2/Groups\",\n    \"4-1\": \"DELETE /scim/v2/Groups/{id}\",\n    \"3-2\": \"Returns a new group with a 201 status code if successful.\",\n    \"4-2\": \"Returns a 204 status code and not content if successful.\",\n    \"0-2\": \"Returns a list of groups and all members, with a 200 status code if successful.\\n\\nSupports:\\n  * [filtering ](https://developers.goformz.com/docs/filtering)by displayname, ie. 'displayname eq {displayname}'\\n  * pagination\",\n    \"1-2\": \"Returns details of a group with a given {id} and all members, with a 200 status code if successful.\",\n    \"2-2\": \"Update supported group details:\\n  * Display Name\\n  * Members\\n  \\nReturns a 200 status code if successful.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59a61b6d18589f000f921181","project":"55357364e02d480d0003c6d3","version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["553591cd63cc650d00312926","553591cd63cc650d00312927","5536e4d39f7f2d0d00b1cd54","5536e55c20d5ca0d0001580a","5536e6bf7fe60f0d000fd1c0","5536f5bba171250d00c00556","553a974369c2630d00a8562e","553a97c60074c80d00621c2a","553a98332af5f20d000fc32a","553a9b9869c2630d00a85642","556e0f23d02e0b190042f13d","563249b1dcc27a1700823650","5639113f049e420d00476b03","59a5dd94aaa11d003334edb4"],"_id":"553591cd63cc650d00312925","project":"55357364e02d480d0003c6d3","releaseDate":"2015-04-20T23:54:53.134Z","__v":13,"forked_from":"55357365e02d480d0003c6d6","createdAt":"2015-04-20T23:54:53.134Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["553591ce63cc650d00312929","553591ce63cc650d0031292a","553591ce63cc650d0031292b","553591ce63cc650d0031292c","553591ce63cc650d0031292d","553591ce63cc650d0031292e","553591ce63cc650d0031292f","553591ce63cc650d00312930"],"title":"API","slug":"api","order":0,"from_sync":false,"reference":false,"_id":"553591cd63cc650d00312926","__v":1,"createdAt":"2015-04-20T21:45:09.762Z","project":"55357364e02d480d0003c6d3","version":"553591cd63cc650d00312925"},"user":"599f1dc97c48d8002381e2d5","createdAt":"2017-08-30T01:57:01.650Z","githubsync":"","__v":0,"parentDoc":null}

SCIM API

System for Cross-domain Identity Management (v2.0)

GoFormz supports SCIM, or System for Cross-domain Identity Management, an open standard that allows you to automate user provisioning using a REST API and JSON. The GoFormz SCIM API follows version 2.0 of the SCIM protocol. For more information, visit our [ServiceProviderConfigs ](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/ServiceProviderConfigs/GetScimConfigs_V2) endpoint on what is supported. [block:callout] { "type": "info", "title": "Authentication", "body": "Our SCIM2.0 endpoints support the same [authentication ](https://developers.goformz.com/docs/authentication)protocols as our API." } [/block] [block:api-header] { "title": "User Endpoints" } [/block] For additional information on what is supported, visit our [User Schema ](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Schemas/GetScimUserSchema_V2) endpoint. [block:parameters] { "data": { "h-0": "Purpose", "h-1": "API", "h-2": "Notes", "h-3": "", "0-0": "[Get Users](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Users/GetScimUsers_V2)", "1-0": "[Get User Details](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Users/GetScimUserById_V2)", "2-0": "[Update User](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Users/PutScimUser_V2)", "0-1": "GET /scim/v2/Users", "1-1": "GET /scim/v2/Users/{id}", "2-1": "PUT /scim/v2/Users/{id}", "3-0": "[Create User](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Users/PostScimUser_V2)", "3-1": "POST /scim/v2/Users", "2-2": "Update supported user details:\n * Username\n * Firstname\n * Lastname\n * Phone Number\n * Password *(optional)*\n * Active *(use for deactivating/reactivating a user) *\nReturns a 200 status code if successful.", "0-2": "Return a list of users and with a 200 status code if successful.\n\nSupports:\n * [filtering ](https://developers.goformz.com/docs/filtering)by username, ie. 'username eq {username}'\n * pagination", "1-2": "Returns details of a user with the given {id} and with a 200 status code if successful.", "3-2": "Password is optional\n\nReturns a new user with a 201 status code if successful." }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "title": "Groups Endpoints" } [/block] For additional information on what is supported, visit our [Group Schema ](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Schemas/GetScimGroupSchema_V2) endpoint. [block:parameters] { "data": { "h-0": "Purpose", "h-1": "API", "h-2": "Notes", "0-0": "[Get Groups (and Members)](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Groups/GetScimGroups_V2)", "1-0": "[Get Group Details (and Members)](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Groups/GetScimGroupById_V2)", "2-0": "[Update Group (and Members)](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Groups/PutScimGroup_V2)", "3-0": "[Create Group](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Groups/PostScimGroup_V2)", "4-0": "[Delete Group](https://api.goformz.com/swagger/index.html?urls.primaryName=scim2#/Groups/DeleteGroup_V2)", "0-1": "GET /scim/v2/Groups", "1-1": "GET /scim/v2/Groups/{id}", "2-1": "PUT /scim/v2/Groups/{id}", "3-1": "POST /scim/v2/Groups", "4-1": "DELETE /scim/v2/Groups/{id}", "3-2": "Returns a new group with a 201 status code if successful.", "4-2": "Returns a 204 status code and not content if successful.", "0-2": "Returns a list of groups and all members, with a 200 status code if successful.\n\nSupports:\n * [filtering ](https://developers.goformz.com/docs/filtering)by displayname, ie. 'displayname eq {displayname}'\n * pagination", "1-2": "Returns details of a group with a given {id} and all members, with a 200 status code if successful.", "2-2": "Update supported group details:\n * Display Name\n * Members\n \nReturns a 200 status code if successful." }, "cols": 3, "rows": 5 } [/block]