{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/Users","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"Resources\": [\n        {\n            \"active\": true,\n            \"emails\": [\n                {\n                    \"display\": null,\n                    \"primary\": false,\n                    \"type\": null,\n                    \"value\": \"evan.testlast:::at:::formstack.com\"\n                }\n            ],\n            \"urn:ietf:params:scim:schemas:extension:formstack:2.0:User\": {\n                \"canCreateForms\": true,\n                \"canCreateThemes\": true,\n                \"isAdmin\": true\n            },\n            \"groups\": [],\n            \"id\": \"1\",\n            \"meta\": {\n                \"created\": \"2015-12-21 17:08:13\",\n                \"lastModified\": \"2018-08-08 11:20:05\",\n                \"location\": \"https://www.formstack.com/scim/Users/1\",\n                \"resourceType\": \"User\",\n            },\n            \"name\": {\n                \"familyName\": \"TestLast\",\n                \"formatted\": \"Evan TestLast\",\n                \"givenName\": \"Evan\"\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/Central\",\n            \"userName\": \"[email protected]\"\n        }\n    ],\n    \"itemsPerPage\": 10,\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n    ],\n    \"startIndex\": 1,\n    \"totalResults\": 1\n}\n","name":""},{"status":400,"language":"json","code":"{\n    \"detail\": \"An unsupported filter was specified\",\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:Error\"\n    ],\n    \"scimType\": null,\n    \"status\": 400\n}","name":""}]},"settings":"5b6af66fa7e2580003fb7cbd","params":[{"name":"count","type":"int","default":"10","desc":"The number of results to return.","required":false,"in":"query","ref":"","_id":"5b6b3447fc81e4000383e12c"},{"name":"filter","type":"string","default":"","desc":"Currently the only supported filter is like 'userName eq \"[email protected]\"'","required":false,"in":"query","ref":"","_id":"5b6b3447fc81e4000383e12b"},{"name":"startIndex","type":"int","default":"1","desc":"The index of the record to start on beginning with 1. For example, with a count of 10, the second \"page\" or results would start with 11.","required":false,"in":"query","ref":"","_id":"5b6b3447fc81e4000383e12a"}],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"/Users","type":"endpoint","slug":"users","excerpt":"","body":"The request is a [Filter](models#section-filter) object.\n\nThe response is a [ListResponse](models#section-listresponse) with the Resources property being an array of [User](models#section-user) objects.","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b6b32e1fc81e4000383e11a","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:13:53.114Z","__v":15,"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

count:
integer10
The number of results to return.
filter:
string
Currently the only supported filter is like 'userName eq "[email protected]"'
startIndex:
integer1
The index of the record to start on beginning with 1. For example, with a count of 10, the second "page" or results would start with 11.

Result Format


Documentation

The request is a [Filter](models#section-filter) object. The response is a [ListResponse](models#section-listresponse) with the Resources property being an array of [User](models#section-user) objects.

User Information

Try It Out

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