{"_id":"5b6b32e1fc81e4000383e11a","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":15,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-08-08T18:13:53.114Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","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\": \"evan.testlast@formstack.com\"\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","language":"json","status":200},{"name":"","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}","language":"json","status":400}]},"settings":"5b6af66fa7e2580003fb7cbd","examples":{"codes":[]},"method":"get","auth":"required","params":[{"_id":"5b6b3447fc81e4000383e12c","ref":"","in":"query","required":false,"desc":"The number of results to return.","default":"10","type":"int","name":"count"},{"_id":"5b6b3447fc81e4000383e12b","ref":"","in":"query","required":false,"desc":"Currently the only supported filter is like 'userName eq \"email@example.com\"'","default":"","type":"string","name":"filter"},{"_id":"5b6b3447fc81e4000383e12a","ref":"","in":"query","required":false,"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.","default":"1","type":"int","name":"startIndex"}],"url":"/Users"},"isReference":false,"order":4,"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.","excerpt":"","slug":"users","type":"endpoint","title":"/Users"}

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@example.com"'
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 }}