post
https://api.recvue.com/api/v2.0/api/scim/Users
SCIM 2.0 compliant user creation endpoint (RFC 7644 §3.3).
MANDATORY FIELDS
Required by the CoreUserController POST API contract.
| SCIM Request Field | CoreUserDTO Field | Description |
|---|---|---|
userName | userName | Unique login identifier (e.g. [email protected]) |
name.givenName | firstName | First name |
name.familyName | lastName | Last name |
emails[0].value | emailAddress | Work email address |
roles[0].value | coreRoleDto[0].roleName | Assigned role name (e.g. Security Admin) |
OPTIONAL FIELDS — SCIM Core Schema (RFC 7643)
| SCIM Request Field | CoreUserDTO Field | Default |
|---|---|---|
active | status | true (→ 'A'); false (→ 'I') |
name.formatted | fullName | Computed from givenName + familyName |
displayName | fullName | Fallback when name.formatted is absent |
title | title | null |
timezone | timezone | null |
locale | languageCode | null (e.g. en) |
addresses[type=work].locality | city | null |
addresses[type=work].region | state | null |
addresses[type=work].country | country | null |
phoneNumbers[type=fax].value | fax | null |
OPTIONAL FIELDS — RecVue Extension
Extension URN: urn:ietf:params:scim:schemas:extension:recvue:2.0:User
| Extension Field | CoreUserDTO Field | Default |
|---|---|---|
company | company | null |
currencyCode | currencyCode | null (e.g. USD) |
readOnlyUser | readOnlyUser | "N" (Y or N) |
dateFormat | dateFormat | null (e.g. MM/dd/yyyy) |
timeFormat | timeFormat | null (e.g. 12HR or 24HR) |
numberFormat | numberFormat | null (e.g. 0.##) |
defaultHomeTab | defaultHomeTab | null (e.g. DAILY_WORKLOAD) |
userBoards | userBoards | null (e.g. REVENUE_GL_TRANSFER) |
defaultUIPreference | defaultUIPreference | null (e.g. BILLRUN) |
apiUser | apiUser | null (Y or N) |
description | description | null |
employeeId | employeeId | null |
customerId | customerId | null |
supplierId | supplierId | null |
roleExtension.dateFrom | coreRoleDto[0].dateFrom | null (yyyy-MM-dd) |
roleExtension.dateTo | coreRoleDto[0].dateTo | null (yyyy-MM-dd) |
roleExtension.attribute1 .. attribute10 | coreRoleDto[0].attribute1..10 | null |
roleExtension.roleInformation1 .. roleInformation3 | coreRoleDto[0].roleInformation1..3 | null |
roleExtension.approvalAuthority | coreRoleDto[0].approvalAuthority | null |
roleExtension.comments | coreRoleDto[0].comments | null |
roleExtension.readOnlyRole | coreRoleDto[0].readOnlyRole | null (Y or N) |
userAttributes[i].attributeContext | coreUserAttributesDto[i].attributeContext | null |
userAttributes[i].attribute1 .. attribute15 | coreUserAttributesDto[i].attribute1..15 | null |
Notes
authenticationSourceis automatically forced toOktafor all SCIM-provisioned users.- Include the extension URN in the
schemasarray when sending extension fields. - Response includes
id,meta.created,meta.lastModified, andLocationheader.
Complete SCIM Request Payload Example
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:recvue:2.0:User"
],
"userName": "[email protected]",
"name": {
"givenName": "John",
"familyName": "Doe",
"formatted": "John Doe"
},
"emails": [{ "value": "[email protected]", "type": "work", "primary": true }],
"active": true,
"title": "Vice President",
"timezone": "IST",
"locale": "en",
"addresses": [{
"type": "work", "locality": "San Francisco",
"region": "CA", "country": "USA", "primary": true
}],
"phoneNumbers": [{ "value": "+1-555-555-5555", "type": "fax" }],
"roles": [{ "value": "Security Admin", "primary": true }],
"urn:ietf:params:scim:schemas:extension:recvue:2.0:User": {
"company": "Recvue",
"readOnlyUser": "N",
"currencyCode": "USD",
"dateFormat": "MM/dd/yyyy",
"timeFormat": "12HR",
"numberFormat": "0.##",
"userBoards": "REVENUE_GL_TRANSFER",
"defaultHomeTab": "DAILY_WORKLOAD",
"defaultUIPreference": "BILLRUN",
"apiUser": "Y",
"description": "User description",
"employeeId": 12345,
"roleExtension": {
"dateFrom": "2024-01-01",
"dateTo": "2026-12-31",
"attribute1": "value1",
"roleInformation1": "info1",
"approvalAuthority": 10000,
"readOnlyRole": "N"
},
"userAttributes": [
{
"attributeContext": "WORKFLOW",
"attribute1": "[email protected]",
"attribute2": "test1",
"attribute3": "test1",
"attribute4": "test1",
"attribute5": "test1"
}
]
}
}References:
- RFC 7643 (SCIM Core Schema): https://datatracker.ietf.org/doc/html/rfc7643
- RFC 7644 (SCIM Protocol): https://datatracker.ietf.org/doc/html/rfc7644
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Forbidden
Not Found