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:

📘

Note:

Currently, in the API Reference, for Create User and Update User endpoints, request and response body parameters are same. Check below to distinguish the required request parameters between these endpoints.

For Create User: displayName, schemas and userName are required. active, externalId, locale, phoneNumbers and title aren't required and default values are "active": true and "locale": "en"

For Update User: active, displayName, locale, schemas and userName are required. externalId, phoneNumbers and title aren't required.

If you don't send any of the above required paramters, you will get an 400 error.

Group

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

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.

📘

Note:

Currently, in the API Reference, for Create Group and Update Group endpoints, request and response body parameters are same. For both these endpoints, displayName and schemas are required request parameters. externalId and members aren't required.

If you don't send any of the above required paramters, you will get an 400 error.