Add, Update or Remove User Information
patch
/rest/v19/scim/users/{id}
This endpoint performs an operation to add user information, update existing user information or remove existing user information for a specified user. The endpoint supports a single operation request or multiple operation requests performed sequentially.
Request
Supported Media Types
- application/json
- application/scim+json
Path Parameters
-
id(required): string
ID of the user
Root Schema : Patch request model
Type:
objectTitle:
Patch request modelRequest to update a user with minimal user payload
Show Source
-
Operations(required):
array Operations
Title:
Operationsupdate patch operation
Nested Schema : operation
Type:
Show Source
object-
op(required):
string
Title:
operationADD/REPLACE/REMOVE operation can be used. -
path:
string
Title:
pathPath is the target source's attibute to update. Filters can also be used to identify the target source.
Response
Supported Media Types
- application/json
Default Response
Response of the updated user.
Root Schema : user-response
Type:
Show Source
object-
active:
boolean
Title:
User statusStatus of the User -
emails:
array Email
Title:
EmailEmail of the User -
enterpriseUser:
object enterpriseUser
-
extensionUser:
object extensionUser
-
id:
string
Title:
Unique resource Id of the UserUnique resource Id of the User -
meta:
object metaData
-
name:
object Name
Title:
NameFull name of the user -
phoneNumbers:
array Phone Numbers
Title:
Phone NumbersPhone numbers of the User -
preferredLanguage:
string
Title:
Preferred LanguagePreferred language of the User -
schemas:
array Schemas
Title:
SchemasSchemas used in the response -
timezone:
string
Title:
timezoneTime zone of the user -
title:
string
Title:
Job title of the UserJob title of the User -
userName:
string
Title:
UsernameLogin Name of the user
Nested Schema : enterpriseUser
Type:
Show Source
object-
organization:
string
Title:
Organizationcompany name of the user
Nested Schema : extensionUser
Type:
Show Source
object-
addresses:
array addresses
-
approvalDelegate:
string
Title:
Approval DelegateApproval Delegate -
currency:
string
Title:
Currency CodePreferred Currency Code of the user -
dateFormat:
integer
Title:
Date Format IdDate Format Id -
enabledForSso:
string
Title:
Enabled For SSOEnabled For SSO -
externalSsoId:
string
Title:
externalSsoIdExternal SSO Id -
fax:
string
Title:
Fax NumberFax of the user -
isAccessAdminPermEnabled:
boolean
Title:
Access Admin Permission EnabledAccess Admin Permission Enabled -
isNotifyEmail:
boolean
Title:
Is Notification Preference EmailIs Notification Preference Email -
isNotifyFax:
boolean
Title:
Is Notification Preference FaxIs Notification preference Fax -
isProxyPermEnabled:
boolean
Title:
Proxy permission enabledProxy permission enabled -
isSuperUserPermEnabled:
boolean
Title:
Is Superuser Permission EnabledIs Superuser Permission Enabled -
isWebServicesOnly:
boolean
Title:
Web Services OnlyWeb Services Only -
numberFormat:
integer
Title:
Number Format IdNumber Format Id -
partnerLogin:
string
Title:
Partner LoginPartner Login of the user -
SeparateShipAddr:
boolean
Title:
Separate ship addressSeparate ship address -
sfdcOrgId:
string
Title:
Sfdc Organization IDSfdc Organization ID -
units:
integer
Title:
UnitsUnits -
userType:
string
Title:
Type of the userType of the user
Nested Schema : metaData
Type:
Show Source
object-
created:
string
Title:
Created dateCreated date of the user -
lastModified:
string
Title:
LastModifiedLastModified date of the user -
location:
string
Title:
locationLocation of the resource -
resourceType:
string
Title:
ResourceTypeType of the resource -
version:
string
Title:
versionVersion of the resource
Nested Schema : Name
Type:
objectTitle:
NameFull name of the user
Show Source
-
familyName:
string
Title:
FamilyNameLast Name of the user -
givenName(required):
string
Title:
GivenNameFirst name of the user
Nested Schema : Phone Numbers
Type:
arrayTitle:
Phone NumbersPhone numbers of the User
Show Source
Nested Schema : email
Type:
Show Source
object-
primary:
boolean
Title:
primaryWhether email is primary or not -
type:
string
Title:
typeType of the email -
value(required):
string
Title:
valuevalue of the email
Nested Schema : address
Type:
Show Source
object-
address1:
string
Title:
Shipping/Billing Address 1Shipping/Billing Address 1 -
address2:
string
Title:
Shipping/Billing Address 2Shipping/Billing Address 2 -
companyName:
string
Title:
Shipping/Billing CompanyShipping/Billing Company -
companyName2:
string
Title:
Shipping/Billing Company2Shipping/Billing Company2 -
country:
string
Title:
Shipping/Billing CountryShipping/Billing Country -
email:
string
Title:
Shipping/Billing EmailShipping/Billing Email -
fax:
string
Title:
Shipping/Billing FaxShipping/Billing Fax -
locality:
string
Title:
Shipping/Billing LocalityShipping/Billing Locality -
name:
object Shipping/Billing Full name
Title:
Shipping/Billing Full nameShipping/Billing Full name -
phone:
string
Title:
Shipping/Billing PhoneShipping/Billing Phone -
postalCode:
string
Title:
Shipping/Billing Postal CodeShipping/Billing Postal Code -
region:
string
Title:
Shipping/Billing RegionShipping/Billing Region -
type:
string
Title:
Address TypeAllowed Values:[ "BILL_TO", "SHIP_TO" ]Address Type
Nested Schema : Shipping/Billing Full name
Type:
objectTitle:
Shipping/Billing Full nameShipping/Billing Full name
Show Source
-
familyName:
string
Title:
Shipping/Billing FamilyNameShipping/Billing FamilyName -
givenName:
string
Title:
Shipping/Billing GivenNameShipping/Billing GivenName
Nested Schema : phoneNumber
Type:
Show Source
object-
primary:
boolean
Title:
primaryWhether phone number is primary or not -
type:
string
Title:
typeType of the phone number -
value:
string
Title:
valuevalue of the phone number
Examples
The following example shows how to add user information, update existing user information, or remove existing user information by submitting a PATCH request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X PATCH -H "Authorization: Bearer <token>" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/scim/users/559a595d-fa7b-43b1-853b-f4ff30b779de
Request Body Sample
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"operations": [{
"op": "replace",
"value": {
"active": true
}
}, {
"op": "remove",
"path": "phoneNumbers"
}, {
"op": "add",
"path": "name",
"value": {
"familyName": "jones",
"givenName": "lisa"
}
}, {
"op": "replace",
"path": "urn:ietf:params:scim:schemas:extension:oracle:2.0:CPQ:User",
"value": {
"userType": "FULLACCESS1",
"addresses": [{
"country": "UK",
"name": {
"familyName": "jones",
"givenName": "lisa"
}
}
]
}
}, {
"op": "remove",
"path": "urn:ietf:params:scim:schemas:extension:oracle:2.0:CPQ:User.addresses.name.givenName"
}, {
"op": "add",
"path": "urn:ietf:params:scim:schemas:extension:oracle:2.0:CPQ:User.addresses[type eq \"SHIP_TO\" and country eq \"UK\" ]",
"value": [{
"country": "JPN",
"name": {
"familyName": "jones",
"givenName": "lisa"
}
}
]
}
]
}
Response Body Sample
{ "schemas": [
"urn:ietf:params:scim:schemas:extension:oracle:2.0:CPQ:User",
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"id": "559a595d-fa7b-43b1-853b-f4ff30b779de",
"meta": {
"resourceType": "User",
"created": "2023-01-12T00:49:54.000Z",
"lastModified": "2023-01-12T00:49:55.000Z",
"version": "v15",
"location": "http://sitename.oracle.com/rest/v19/scim/users/559a595d-fa7b-43b1-853b-f4ff30b779de"
},
"userName": "lisaJones",
"emails": [
{
"value": "lisa.jones@companyemail.com",
"type": "WORK",
"primary": true
}
],
"active": true,
"preferredLanguage": "en_US",
"name": {
"familyName": "jones",
"givenName": "lisa"
},
"title": "FullAccess User",
"timezone": "America/New_York",
"urn:ietf:params:scim:schemas:extension:oracle:2.0:CPQ:User": {
"userType": "FULL_ACCESS",
"currency": "EUR",
"dateFormat": 3,
"numberFormat": 0,
"units": 1,
"enabledForSso": "SSO_ENABLED",
"separateShipaddr": false,
"addresses": [
{
"type": "BILL_TO",
"name": {
"familyName": "jones",
"givenName": "lisa"
},
"address1": "2 waters park dr",
"address2": "Po2 suite 240-2",
"locality": "SanMateo",
"companyName": "PO2",
"region": "California",
"postalCode": "94403",
"country": "UK",
"phone": "650-403-6322",
"fax": "650-403-6322",
"email": "lisa.jones@companyemail.com"
},
{
"type": "SHIP_TO",
"name": {
"familyName": "jones",
"givenName": "lisa"
},
"address1": "2 waters park dr",
"address2": "Po2 suite 240-2",
"locality": "SanMateo",
"companyName": "po2",
"region": "California",
"postalCode": "94403",
"country": "JPN",
"phone": "650-403-6322",
"fax": "650-403-6322",
"email": "lisa.jones@companyemail.com"
}
],
"isNotifyEmail": false,
"isSuperUserPermEnabled": false,
"isAccessAdminPermEnabled": false,
"isProxyPermEnabled": false,
"isNotifyFax": false,
"isWebServicesOnly": false
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"organization": "phoenix60388"
}
}