Models Reference

User Models

User

Schema: urn:ietf:params:scim:schemas:core:2.0:User

NameTypeRequired
schemasstring[]yes
idintedit
metaMetano
userNamestringyes
nameNameyes
timezonestringno
activeboolyes
emailsMultiValueAttribute[]no
groupsMultiValueAttribute[]no
urn:ietf:params:scim:schemas:extension:formstack:2.0:UserUserFormstackExtensionno

Name

NameTypeRequired
formattedstringno
familyNamestringyes
givenNamestringyes

UserFormstackExtension

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

NameTypeRequired
canCreateFormsboolno
canCreateThemesboolno
foldersFolder[]no
formsForm[]no
isAdminboolno
isParticipantUserboolno
mustLoginUsingSsoboolno

Group Models

GroupCore

NameTypeRequired
schemasstring[]yes
idintedit
metaMetano
displayNamestringno
membersMultiValueAttribute[]no

GroupFormstackExtension

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

NameTypeRequired
foldersFolder[]no
formsForm[]no

Form Models

Form

NameTypeRequired
schemasstring[]yes
idintedit
metaMetano
namestringyes
permissionsFormPermissionno

Folder Models

Folder

NameTypeRequired
schemasstring[]yes
idintedit
metaMetano
namestringyes
parentFolderIdintno
permissionsFormPermissionno

Common Models

ListResponse

Schema: urn:ietf:params:scim:api:messages:2.0:ListResponse

NameTypeRequired
totalResultsintyes
itemsPerPageintyes
startIndexintyes
schemasstring[]yes
ResourcesUser[] or Group[]yes

Filter

NameTypeRequired
countintno
filterstringno
startIndexintno

MultiValueAttribute

NameTypeRequired
typestringno
primaryboolno
displaystringno
valuestringno

Meta

NameTypeRequired
createdstringno
lastModifiedstringno
locationstringno
resourceTypestringno

FormPermission

NameTypeRequired
canEditSubmissionsboolyes
canViewSubmissionsboolyes
isAdminboolyes

Error

NameTypeRequired
schemasstring[]yes
scimTypestringno
detailstringyes
statusintyes

Patch Operation Models

PatchOperations

NameTypeRequired
schemasstring[]yes
OperationsPatchOperation[]yes

PatchOperation

NameTypeRequired
opstringyes
pathstringno
valuearrayyes