Update a User
put
/rest/v16/scim/users/{id}
This endpoint updates an existing user.
Request
Supported Media Types
- application/json
- application/scim+json
Path Parameters
-
id(required): string
The unique identifier for the user.
Root Schema : User request model
Type:
object
Title:
User request model
Request for creating a user
Show Source
-
active:
boolean
Title:
User status
Status of the User -
emails(required):
array Email
Title:
Email
Email of the User -
enterpriseUser(required):
object enterpriseUser
-
extensionUser(required):
object extensionUser
-
name(required):
object Name
Title:
Name
Full name of the user -
phoneNumbers:
array Phone Numbers
Title:
Phone Numbers
Phone numbers of the User -
preferredLanguage:
string
Title:
Preferred Language
Preferred language of the User -
timezone:
string
Title:
timezone
Time zone of the user -
title:
string
Title:
Job title of the User
Job title of the User -
userName(required):
string
Title:
Username
Login Name of the user
Nested Schema : enterpriseUser
Type:
Show Source
object
-
organization(required):
string
Title:
Organization
Company name of the user
Nested Schema : extensionUser
Type:
Show Source
object
-
addresses:
array addresses
-
approvalDelegate:
string
Title:
Approval Delegate
Approval Delegate -
currency:
string
Title:
Currency Code
Preferred Currency Code of the user -
dateFormat:
integer
Title:
Date Format Id
Date Format Id -
enabledForSso:
string
Title:
Enabled For SSO
Enabled For SSO -
externalSsoId:
string
Title:
externalSsoId
External SSO Id -
fax:
string
Title:
Fax Number
Fax of the user -
isAccessAdminPermEnabled:
boolean
Title:
Access Admin Permission Enabled
Access Admin Permission Enabled -
isNotifyEmail:
boolean
Title:
Is Notification Preference Email
Is Notification Preference Email -
isNotifyFax:
boolean
Title:
Is Notification Preference Fax
Is Notification preference Fax -
isProxyPermEnabled:
boolean
Title:
Proxy permission enabled
Proxy permission enabled -
isSuperUserPermEnabled:
boolean
Title:
Is Superuser Permission Enabled
Is Superuser Permission Enabled -
isWebServicesOnly:
boolean
Title:
Web Services Only
Web Services Only -
numberFormat:
integer
Title:
Number Format Id
Number Format Id -
partnerLogin:
string
Title:
Partner Login
Partner Login of the user -
SeparateShipAddr:
boolean
Title:
Separate ship address
Separate ship address -
sfdcOrgId:
string
Title:
Sfdc Organization ID
Sfdc Organization ID -
units:
integer
Title:
Units
Units -
userType:
string
Title:
Type of the user
Type of the user
Nested Schema : Name
Type:
object
Title:
Name
Full name of the user
Show Source
-
familyName:
string
Title:
FamilyName
Last Name of the user -
givenName(required):
string
Title:
GivenName
First name of the user
Nested Schema : Phone Numbers
Type:
array
Title:
Phone Numbers
Phone numbers of the User
Show Source
Nested Schema : email
Type:
Show Source
object
-
primary:
boolean
Title:
primary
Whether email is primary or not -
type:
string
Title:
type
Type of the email -
value(required):
string
Title:
value
value of the email
Nested Schema : address
Type:
Show Source
object
-
address1:
string
Title:
Shipping/Billing Address 1
Shipping/Billing Address 1 -
address2:
string
Title:
Shipping/Billing Address 2
Shipping/Billing Address 2 -
companyName:
string
Title:
Shipping/Billing Company
Shipping/Billing Company -
companyName2:
string
Title:
Shipping/Billing Company2
Shipping/Billing Company2 -
country:
string
Title:
Shipping/Billing Country
Shipping/Billing Country -
email:
string
Title:
Shipping/Billing Email
Shipping/Billing Email -
fax:
string
Title:
Shipping/Billing Fax
Shipping/Billing Fax -
locality:
string
Title:
Shipping/Billing Locality
Shipping/Billing Locality -
name:
object Shipping/Billing Full name
Title:
Shipping/Billing Full name
Shipping/Billing Full name -
phone:
string
Title:
Shipping/Billing Phone
Shipping/Billing Phone -
postalCode:
string
Title:
Shipping/Billing Postal Code
Shipping/Billing Postal Code -
region:
string
Title:
Shipping/Billing Region
Shipping/Billing Region -
type:
string
Title:
Address Type
Allowed Values:[ "BILL_TO", "SHIP_TO" ]
Address Type
Nested Schema : Shipping/Billing Full name
Type:
object
Title:
Shipping/Billing Full name
Shipping/Billing Full name
Show Source
-
familyName:
string
Title:
Shipping/Billing FamilyName
Shipping/Billing FamilyName -
givenName:
string
Title:
Shipping/Billing GivenName
Shipping/Billing GivenName
Nested Schema : phoneNumber
Type:
Show Source
object
-
primary:
boolean
Title:
primary
Whether phone number is primary or not -
type:
string
Title:
type
Type of the phone number -
value:
string
Title:
value
value of the phone number
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 status
Status of the User -
emails:
array Email
Title:
Email
Email of the User -
enterpriseUser:
object enterpriseUser
-
extensionUser:
object extensionUser
-
id:
string
Title:
Unique resource Id of the User
Unique resource Id of the User -
meta:
object metaData
-
name:
object Name
Title:
Name
Full name of the user -
phoneNumbers:
array Phone Numbers
Title:
Phone Numbers
Phone numbers of the User -
preferredLanguage:
string
Title:
Preferred Language
Preferred language of the User -
schemas:
array Schemas
Title:
Schemas
Schemas used in the response -
timezone:
string
Title:
timezone
Time zone of the user -
title:
string
Title:
Job title of the User
Job title of the User -
userName:
string
Title:
Username
Login Name of the user
Nested Schema : enterpriseUser
Type:
Show Source
object
-
organization:
string
Title:
Organization
company name of the user
Nested Schema : extensionUser
Type:
Show Source
object
-
addresses:
array addresses
-
approvalDelegate:
string
Title:
Approval Delegate
Approval Delegate -
currency:
string
Title:
Currency Code
Preferred Currency Code of the user -
dateFormat:
integer
Title:
Date Format Id
Date Format Id -
enabledForSso:
string
Title:
Enabled For SSO
Enabled For SSO -
externalSsoId:
string
Title:
externalSsoId
External SSO Id -
fax:
string
Title:
Fax Number
Fax of the user -
isAccessAdminPermEnabled:
boolean
Title:
Access Admin Permission Enabled
Access Admin Permission Enabled -
isNotifyEmail:
boolean
Title:
Is Notification Preference Email
Is Notification Preference Email -
isNotifyFax:
boolean
Title:
Is Notification Preference Fax
Is Notification preference Fax -
isProxyPermEnabled:
boolean
Title:
Proxy permission enabled
Proxy permission enabled -
isSuperUserPermEnabled:
boolean
Title:
Is Superuser Permission Enabled
Is Superuser Permission Enabled -
isWebServicesOnly:
boolean
Title:
Web Services Only
Web Services Only -
numberFormat:
integer
Title:
Number Format Id
Number Format Id -
partnerLogin:
string
Title:
Partner Login
Partner Login of the user -
SeparateShipAddr:
boolean
Title:
Separate ship address
Separate ship address -
sfdcOrgId:
string
Title:
Sfdc Organization ID
Sfdc Organization ID -
units:
integer
Title:
Units
Units -
userType:
string
Title:
Type of the user
Type of the user
Nested Schema : metaData
Type:
Show Source
object
-
created:
string
Title:
Created date
Created date of the user -
lastModified:
string
Title:
LastModified
LastModified date of the user -
location:
string
Title:
location
Location of the resource -
resourceType:
string
Title:
ResourceType
Type of the resource -
version:
string
Title:
version
Version of the resource
Nested Schema : Name
Type:
object
Title:
Name
Full name of the user
Show Source
-
familyName:
string
Title:
FamilyName
Last Name of the user -
givenName(required):
string
Title:
GivenName
First name of the user
Nested Schema : Phone Numbers
Type:
array
Title:
Phone Numbers
Phone numbers of the User
Show Source
Nested Schema : email
Type:
Show Source
object
-
primary:
boolean
Title:
primary
Whether email is primary or not -
type:
string
Title:
type
Type of the email -
value(required):
string
Title:
value
value of the email
Nested Schema : address
Type:
Show Source
object
-
address1:
string
Title:
Shipping/Billing Address 1
Shipping/Billing Address 1 -
address2:
string
Title:
Shipping/Billing Address 2
Shipping/Billing Address 2 -
companyName:
string
Title:
Shipping/Billing Company
Shipping/Billing Company -
companyName2:
string
Title:
Shipping/Billing Company2
Shipping/Billing Company2 -
country:
string
Title:
Shipping/Billing Country
Shipping/Billing Country -
email:
string
Title:
Shipping/Billing Email
Shipping/Billing Email -
fax:
string
Title:
Shipping/Billing Fax
Shipping/Billing Fax -
locality:
string
Title:
Shipping/Billing Locality
Shipping/Billing Locality -
name:
object Shipping/Billing Full name
Title:
Shipping/Billing Full name
Shipping/Billing Full name -
phone:
string
Title:
Shipping/Billing Phone
Shipping/Billing Phone -
postalCode:
string
Title:
Shipping/Billing Postal Code
Shipping/Billing Postal Code -
region:
string
Title:
Shipping/Billing Region
Shipping/Billing Region -
type:
string
Title:
Address Type
Allowed Values:[ "BILL_TO", "SHIP_TO" ]
Address Type
Nested Schema : Shipping/Billing Full name
Type:
object
Title:
Shipping/Billing Full name
Shipping/Billing Full name
Show Source
-
familyName:
string
Title:
Shipping/Billing FamilyName
Shipping/Billing FamilyName -
givenName:
string
Title:
Shipping/Billing GivenName
Shipping/Billing GivenName
Nested Schema : phoneNumber
Type:
Show Source
object
-
primary:
boolean
Title:
primary
Whether phone number is primary or not -
type:
string
Title:
type
Type of the phone number -
value:
string
Title:
value
value of the phone number