Data model

The Oneflow SCIM API has two main resource types, User and Group.

User

The User resource type defines only a subset of the attributes defined in the SCIM core schema (urn:ietf:params:scim:schemas:core:2.0:User).

While our resource definition for a user does list the extended EnterpriseUser schema (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User), it is only there for compatibility purposes with specific SCIM clients.

🚧

Note:

None of the fields defined in the EnterpriseUser schema is present in our User resource type.

You can find the following attributes in our user resource type:

AttributeDescriptionNotes
idOneflow IDRead-only
externalIdSCIM client mapping ID
userNameUser email addressRequired, must be unique
displayNameDisplay nameRequired
titleTitle
localeLanguage settingISO 639‑1
Two-letter language code
Without region
activeEnabled/disabled user
phoneNumbersPhone number of user for SMSA max of one phone number is allowed
Must be of type 'work'
groupsThe groups the user is a member ofRead-only
Edit through groups resource
metaSCIM meta infoRead-only
schemasSCIM schemas infoRead-only

Group

The Group resource type defines all attributes from the SCIM core schema (urn:ietf:params:scim:schemas:core:2.0:Group).

AttributeDescriptionNotes
idOneflow IDRead-only
externalIdSCIM client mapping ID
displayNameDisplays the name of the group.Required; must be unique.
membersThe list of members in the group.Only users; cannot nest groups.
metaSCIM meta infoRead-only
schemasSCIM schema infoRead-only

You can use the schemas endpoint to see which of the attributes from the core schemas are defined on our resource types, their mutability if required, and so on.