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	no
userName	string	yes
name	Name	yes
timezone	string	no
active	bool	yes
emails	MultiValueAttribute[]	no
groups	MultiValueAttribute[]	no
urn:ietf:params:scim:schemas:extension:formstack:2.0:User	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[]	no
forms	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[]	no

GroupFormstackExtension

Schema: urn:ietf:params:scim:schemas:extension:formstack:2.0:Group

Name	Type	Required
folders	Folder[]	no
forms	Form[]	no

Form Models

Form

Name	Type	Required
schemas	string[]	yes
id	int	edit
meta	Meta	no
name	string	yes
permissions	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	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[] or 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[]	yes

PatchOperation

Name	Type	Required
op	string	yes
path	string	no
value	array	yes