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:
| Attribute | Description | Notes |
| active | Enabled/disabled user | ο»Ώ |
| displayName | Display name | Required |
| roles | SCIM user roles | optional |
| externalId | SCIM client mapping ID | ο»Ώ |
| groups | The groups the user is a member of | Read-only Edit through groups resource |
| id | Oneflow ID | Read-only |
| locale | Language setting | ISO 639β1 Two-letter language code Without region |
| meta | SCIM meta info | Read-only |
| phoneNumbers | Phone number of user for SMS | A max of one phone number is allowed Must be of type 'work' |
| schemas | SCIM schemas info | Read-only |
| title | Title | ο»Ώ |
| userName | User email address | Required, must be unique |
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_).
| Attribute | Description | Notes |
| displayName | Displays the name of the group. | Required; must be unique. |
| externalId | SCIM client mapping ID | ο»Ώ |
| id | Oneflow ID | Read-only |
| members | The list of members in the group. | Only users; cannot nest groups. |
| meta | SCIM meta info | Read-only |
| schemas | SCIM schema info | Read-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.
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.