{"_id":"5b7434923c064e000335e2dd","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":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-08-15T14:11:30.774Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"## User Models\n\n### User\n\nSchema: `urn:ietf:params:scim:schemas:core:2.0:User `\n\nName | Type | Required\n--- | --- | ---\nschemas | string[] | yes\nid | int | edit\nmeta | [Meta](#section-meta) | no\nuserName | string | yes\nname | [Name](#section-name) | yes\ntimezone | string | no\nactive | bool | yes\nemails | [MultiValueAttribute](#section-multivalueattribute)[] | no\ngroups | [MultiValueAttribute](#section-multivalueattribute)[] | no\nurn:ietf:params:scim:schemas:extension:formstack:2.0:User | [UserFormstackExtension](#section-userformstackextension) | no\n\n\n### Name\n\nName | Type | Required\n--- | --- | ---\nformatted | string | no\nfamilyName | string | yes\ngivenName | string | yes\n\n\n### UserFormstackExtension\n\nSchema: `urn:ietf:params:scim:schemas:extension:formstack:2.0:User`\n\nName | Type | Required\n--- | --- | ---\ncanCreateForms | bool | no\ncanCreateThemes | bool | no\nfolders | [Folder](#section-folder)[] | no\nforms | [Form](#section-form)[] | no\nisAdmin | bool | no\nisParticipantUser | bool | no\nmustLoginUsingSso | bool | no\n\n\n## Group Models\n\n### GroupCore\n\nName | Type | Required\n--- | --- | ---\nschemas | string[] | yes\nid | int | edit\nmeta | Meta | no\ndisplayName | string | no\nmembers | [MultiValueAttribute](#section-multivalueattribute)[] | no\n\n\n### GroupFormstackExtension\n\nSchema: `urn:ietf:params:scim:schemas:extension:formstack:2.0:Group`\n\nName | Type | Required\n--- | --- | ---\nfolders | [Folder](#section-folder)[] | no\nforms | [Form](#section-form)[] | no\n\n\n## Form Models\n\n### Form\n\nName | Type | Required\n--- | --- | ---\nschemas | string[] | yes\nid | int | edit\nmeta | Meta | no\nname | string | yes\npermissions | [FormPermission](#section-formpermission) | no\n\n\n## Folder Models\n\n### Folder\n\nName | Type | Required\n--- | --- | ---\nschemas | string[] | yes\nid | int | edit\nmeta | Meta | no\nname | string | yes\nparentFolderId | int | no\npermissions | [FormPermission](#section-formpermission) | no\n\n## Common Models\n\n### ListResponse\n\nSchema: `urn:ietf:params:scim:api:messages:2.0:ListResponse`\n\nName | Type | Required\n--- | --- | ---\ntotalResults | int | yes\nitemsPerPage | int | yes\nstartIndex | int | yes\nschemas | string[] | yes\nResources | [User](#section-user)[] or [Group](#section-group)[] | yes\n\n\n### Filter\n\nName | Type | Required\n--- | --- | ---\ncount | int | no\nfilter | string | no\nstartIndex | int | no\n\n\n### MultiValueAttribute\n\nName | Type | Required\n--- | --- | ---\ntype | string | no\nprimary | bool | no\ndisplay | string | no\nvalue | string | no\n\n\n### Meta\n\nName | Type | Required\n--- | --- | ---\ncreated | string | no\nlastModified | string | no\nlocation | string | no\nresourceType | string | no\n\n\n### FormPermission\n\nName | Type | Required\n--- | --- | ---\ncanEditSubmissions | bool | yes\ncanViewSubmissions | bool | yes\nisAdmin | bool | yes\n\n\n### Error\n\nName | Type | Required\n--- | --- | ---\nschemas | string[] | yes\nscimType | string | no\ndetail | string | yes\nstatus | int | yes\n\n\n## Patch Operation Models\n\n### PatchOperations\n\nName | Type | Required\n--- | --- | ---\nschemas | string[] | yes\nOperations | [PatchOperation](#section-patchoperation)[] | yes\n\n\n### PatchOperation\n\nName | Type | Required\n--- | --- | ---\nop | string | yes\npath | string | no\nvalue | array | yes","excerpt":"","slug":"models","type":"basic","title":"Models Reference"}
## User Models ### User Schema: `urn:ietf:params:scim:schemas:core:2.0:User ` Name | Type | Required --- | --- | --- schemas | string[] | yes id | int | edit meta | [Meta](#section-meta) | no userName | string | yes name | [Name](#section-name) | yes timezone | string | no active | bool | yes emails | [MultiValueAttribute](#section-multivalueattribute)[] | no groups | [MultiValueAttribute](#section-multivalueattribute)[] | no urn:ietf:params:scim:schemas:extension:formstack:2.0:User | [UserFormstackExtension](#section-userformstackextension) | no ### Name Name | Type | Required --- | --- | --- formatted | string | no familyName | string | yes givenName | string | yes ### UserFormstackExtension Schema: `urn:ietf:params:scim:schemas:extension:formstack:2.0:User` Name | Type | Required --- | --- | --- canCreateForms | bool | no canCreateThemes | bool | no folders | [Folder](#section-folder)[] | no forms | [Form](#section-form)[] | no isAdmin | bool | no isParticipantUser | bool | no mustLoginUsingSso | bool | no ## Group Models ### GroupCore Name | Type | Required --- | --- | --- schemas | string[] | yes id | int | edit meta | Meta | no displayName | string | no members | [MultiValueAttribute](#section-multivalueattribute)[] | no ### GroupFormstackExtension Schema: `urn:ietf:params:scim:schemas:extension:formstack:2.0:Group` Name | Type | Required --- | --- | --- folders | [Folder](#section-folder)[] | no forms | [Form](#section-form)[] | no ## Form Models ### Form Name | Type | Required --- | --- | --- schemas | string[] | yes id | int | edit meta | Meta | no name | string | yes permissions | [FormPermission](#section-formpermission) | no ## Folder Models ### Folder Name | Type | Required --- | --- | --- schemas | string[] | yes id | int | edit meta | Meta | no name | string | yes parentFolderId | int | no permissions | [FormPermission](#section-formpermission) | no ## Common Models ### ListResponse Schema: `urn:ietf:params:scim:api:messages:2.0:ListResponse` Name | Type | Required --- | --- | --- totalResults | int | yes itemsPerPage | int | yes startIndex | int | yes schemas | string[] | yes Resources | [User](#section-user)[] or [Group](#section-group)[] | yes ### Filter Name | Type | Required --- | --- | --- count | int | no filter | string | no startIndex | int | no ### MultiValueAttribute Name | Type | Required --- | --- | --- type | string | no primary | bool | no display | string | no value | string | no ### Meta Name | Type | Required --- | --- | --- created | string | no lastModified | string | no location | string | no resourceType | string | no ### FormPermission Name | Type | Required --- | --- | --- canEditSubmissions | bool | yes canViewSubmissions | bool | yes isAdmin | bool | yes ### Error Name | Type | Required --- | --- | --- schemas | string[] | yes scimType | string | no detail | string | yes status | int | yes ## Patch Operation Models ### PatchOperations Name | Type | Required --- | --- | --- schemas | string[] | yes Operations | [PatchOperation](#section-patchoperation)[] | yes ### PatchOperation Name | Type | Required --- | --- | --- op | string | yes path | string | no value | array | yes