Update a user
put
/api/rest/2.0/system/user/{id}
Updates the user specified by the
id
parameter. Users without the "ManageUsers" action permission can only update their own user account.Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
The ID of the user to update
The request body defines the details of the user to be updated
Root Schema : User
Type:
object
Title:
Show Source
User
-
address1:
string
User's address line 1.
-
address2:
string
User's address line 2.
-
betaAccess:
array betaAccess
A list of strings: beta programs the user can access.
-
capabilities:
array capabilities
A list of strings: the user's capabilities.
-
cellPhone:
string
Mobile phone number of the user.
-
city:
string
The name of the user's city.
-
companyDisplayName:
string
Name of the user's company to be displayed.
-
companyUrl:
string
URL of the user's company.
-
country:
string
The name of the user's country.
-
createdAt:
string
Read Only:
true
The date and time the user was created, expressed in Unix time. This is a read-only property. -
createdBy:
string
Read Only:
true
The login id of the user who created the user. This is a read-only property. -
createdByName:
string
The name of the user who created the user.
-
crmUsername:
string
User's identifier in default CRM.
-
crmUserNames:
object crmUserNames
Title:
crmUserNames
-
currentStatus:
string
This property is not used.
-
defaultAccountViewId:
string
The user's default account view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
-
defaultContactViewId:
string
The user's default contact view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
-
department:
string
Name of the user's department.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. This is a read-only property. -
description:
string
The description of the user.
-
digitalSignatureId:
string
Internal id of user's digital signature.
-
emailAddress:
string
The user's email address.
-
fax:
string
Fax number of the user.
-
federationId:
string
The user's Federation Id.
-
firstName:
string
The first name of the user.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the user. This is a read-only property. -
id:
string
Read Only:
true
Id of the user. This is a read-only property. -
interfacePermissions:
array interfacePermissions
A list of the user's interface permissions.
-
isAssetManager:
string
User_Field_IsAssetManager_Description
-
isDeleted:
string
Indicates if the user is deleted.
-
isDisabled:
string
Read Only:
true
Indicates if the user is disabled. -
isUsingBrightenTemplate:
string
This parameter is not used.
-
jobTitle:
string
Job title of the user.
-
lastName:
string
The last name of the user.
-
loginName:
string
The user's name used to login. This is a read-only property.
-
name:
string
The name of the user. This is a read-only property.
-
passwordExpires:
string
Indicates if user's password can expire.
-
permissions:
array permissions
The permissions for the user granted to your current instance. This is a read-only property.
-
personalMessage:
string
User's personal message.
-
personalPhotoId:
string
Internal id of user's personal photo.
-
personalUrl:
string
User's personal URL.
-
phone:
string
Phone number of the user.
-
preferences:
object UserPreferences
Title:
UserPreferences
-
productPermissions:
array productPermissions
A list of the user's product permissions.
-
replyToAddress:
string
User's email address used as "reply to" address.
-
scheduledFor:
string
Read Only:
true
This parameter is not used. -
securityGroups:
array securityGroups
The user's security groups.
-
senderDisplayName:
string
User's "Sender Display Name"
-
senderEmailAddress:
string
User's "Sender Email Address"
-
sendWelcomeEmail:
string
Indicates if "User Welcome" email would be sent to user upon user creation.
-
shortcuts:
array shortcuts
This parameter is not used.
-
sourceTemplateId:
string
Id of template used to create the user.
-
ssoOnly:
string
Indicates if the user can only login using Single Sign On.
-
state:
string
The name of the user's state or province.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
typePermissions:
array typePermissions
A list of the user's type permissions.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the user was last updated. This is a read-only property. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the user. This is a read-only property. -
updatedByName:
string
The name of the user who last updated the user.
-
zipCode:
string
User's ZIP or postal code.
Nested Schema : betaAccess
Type:
array
A list of strings: beta programs the user can access.
Show Source
Nested Schema : crmUserNames
Type:
object
Title:
Show Source
crmUserNames
-
MSDUserName:
string
-
OSCUserName:
string
-
SFDCUserName:
string
-
SODUserName:
string
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : interfacePermissions
Type:
array
A list of the user's interface permissions.
Show Source
-
Array of:
object InterfacePermission
Title:
InterfacePermission
Nested Schema : permissions
Type:
array
The permissions for the user granted to your current instance. This is a read-only property.
Show Source
Nested Schema : UserPreferences
Type:
object
Title:
Show Source
UserPreferences
-
timezoneId:
string
The ID of the user's timezone in Eloqua.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : productPermissions
Type:
array
A list of the user's product permissions.
Show Source
-
Array of:
object ProductPermission
Title:
ProductPermission
Nested Schema : securityGroups
Type:
array
The user's security groups.
Show Source
-
Array of:
object SecurityGroup
Title:
SecurityGroup
Nested Schema : typePermissions
Type:
array
A list of the user's type permissions.
Show Source
-
Array of:
object TypePermission
Title:
TypePermission
Nested Schema : InterfacePermission
Type:
object
Title:
Show Source
InterfacePermission
-
interfaceCode:
string
-
name:
string
-
nestedInterfacePermissions:
array nestedInterfacePermissions
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : nestedInterfacePermissions
Type:
Show Source
array
-
Array of:
object InterfacePermission
Title:
InterfacePermission
Nested Schema : ProductPermission
Type:
object
Title:
Show Source
ProductPermission
-
productCode:
string
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : SecurityGroup
Type:
object
Title:
Show Source
SecurityGroup
-
acronym:
string
Acronym for the security group
-
createdAt:
string
Read Only:
true
The date and time the security group was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the security group. -
createdByName:
string
The name of the user who created the security group.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the security group.
-
id:
string
Read Only:
true
Id of the security group. -
isEffective:
string
Read Only:
true
Indicates if the security group is effective. -
isReadOnly:
string
Read Only:
true
Indicates if the security group is read only. -
name:
string
The name of the security group.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the security group was last updated. This is a read-only property. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the security group. This is a read-only property. -
updatedByName:
string
The name of the user who last updated the security group.
Nested Schema : TypePermission
Type:
object
Title:
Show Source
TypePermission
-
objectType:
string
-
permissions:
object TypePermissions
Title:
TypePermissions
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : TypePermissions
Type:
object
Title:
Show Source
TypePermissions
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : User
Type:
object
Title:
Show Source
User
-
address1:
string
User's address line 1.
-
address2:
string
User's address line 2.
-
betaAccess:
array betaAccess
A list of strings: beta programs the user can access.
-
capabilities:
array capabilities
A list of strings: the user's capabilities.
-
cellPhone:
string
Mobile phone number of the user.
-
city:
string
The name of the user's city.
-
companyDisplayName:
string
Name of the user's company to be displayed.
-
companyUrl:
string
URL of the user's company.
-
country:
string
The name of the user's country.
-
createdAt:
string
Read Only:
true
The date and time the user was created, expressed in Unix time. This is a read-only property. -
createdBy:
string
Read Only:
true
The login id of the user who created the user. This is a read-only property. -
createdByName:
string
The name of the user who created the user.
-
crmUsername:
string
User's identifier in default CRM.
-
crmUserNames:
object crmUserNames
Title:
crmUserNames
-
currentStatus:
string
This property is not used.
-
defaultAccountViewId:
string
The user's default account view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
-
defaultContactViewId:
string
The user's default contact view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
-
department:
string
Name of the user's department.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. This is a read-only property. -
description:
string
The description of the user.
-
digitalSignatureId:
string
Internal id of user's digital signature.
-
emailAddress:
string
The user's email address.
-
fax:
string
Fax number of the user.
-
federationId:
string
The user's Federation Id.
-
firstName:
string
The first name of the user.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the user. This is a read-only property. -
id:
string
Read Only:
true
Id of the user. This is a read-only property. -
interfacePermissions:
array interfacePermissions
A list of the user's interface permissions.
-
isAssetManager:
string
User_Field_IsAssetManager_Description
-
isDeleted:
string
Indicates if the user is deleted.
-
isDisabled:
string
Read Only:
true
Indicates if the user is disabled. -
isUsingBrightenTemplate:
string
This parameter is not used.
-
jobTitle:
string
Job title of the user.
-
lastName:
string
The last name of the user.
-
loginName:
string
The user's name used to login. This is a read-only property.
-
name:
string
The name of the user. This is a read-only property.
-
passwordExpires:
string
Indicates if user's password can expire.
-
permissions:
array permissions
The permissions for the user granted to your current instance. This is a read-only property.
-
personalMessage:
string
User's personal message.
-
personalPhotoId:
string
Internal id of user's personal photo.
-
personalUrl:
string
User's personal URL.
-
phone:
string
Phone number of the user.
-
preferences:
object UserPreferences
Title:
UserPreferences
-
productPermissions:
array productPermissions
A list of the user's product permissions.
-
replyToAddress:
string
User's email address used as "reply to" address.
-
scheduledFor:
string
Read Only:
true
This parameter is not used. -
securityGroups:
array securityGroups
The user's security groups.
-
senderDisplayName:
string
User's "Sender Display Name"
-
senderEmailAddress:
string
User's "Sender Email Address"
-
sendWelcomeEmail:
string
Indicates if "User Welcome" email would be sent to user upon user creation.
-
shortcuts:
array shortcuts
This parameter is not used.
-
sourceTemplateId:
string
Id of template used to create the user.
-
ssoOnly:
string
Indicates if the user can only login using Single Sign On.
-
state:
string
The name of the user's state or province.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
typePermissions:
array typePermissions
A list of the user's type permissions.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the user was last updated. This is a read-only property. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the user. This is a read-only property. -
updatedByName:
string
The name of the user who last updated the user.
-
zipCode:
string
User's ZIP or postal code.
Nested Schema : betaAccess
Type:
array
A list of strings: beta programs the user can access.
Show Source
Nested Schema : crmUserNames
Type:
object
Title:
Show Source
crmUserNames
-
MSDUserName:
string
-
OSCUserName:
string
-
SFDCUserName:
string
-
SODUserName:
string
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : interfacePermissions
Type:
array
A list of the user's interface permissions.
Show Source
-
Array of:
object InterfacePermission
Title:
InterfacePermission
Nested Schema : permissions
Type:
array
The permissions for the user granted to your current instance. This is a read-only property.
Show Source
Nested Schema : UserPreferences
Type:
object
Title:
Show Source
UserPreferences
-
timezoneId:
string
The ID of the user's timezone in Eloqua.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : productPermissions
Type:
array
A list of the user's product permissions.
Show Source
-
Array of:
object ProductPermission
Title:
ProductPermission
Nested Schema : securityGroups
Type:
array
The user's security groups.
Show Source
-
Array of:
object SecurityGroup
Title:
SecurityGroup
Nested Schema : typePermissions
Type:
array
A list of the user's type permissions.
Show Source
-
Array of:
object TypePermission
Title:
TypePermission
Nested Schema : InterfacePermission
Type:
object
Title:
Show Source
InterfacePermission
-
interfaceCode:
string
-
name:
string
-
nestedInterfacePermissions:
array nestedInterfacePermissions
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : nestedInterfacePermissions
Type:
Show Source
array
-
Array of:
object InterfacePermission
Title:
InterfacePermission
Nested Schema : ProductPermission
Type:
object
Title:
Show Source
ProductPermission
-
productCode:
string
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : SecurityGroup
Type:
object
Title:
Show Source
SecurityGroup
-
acronym:
string
Acronym for the security group
-
createdAt:
string
Read Only:
true
The date and time the security group was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the security group. -
createdByName:
string
The name of the user who created the security group.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the security group.
-
id:
string
Read Only:
true
Id of the security group. -
isEffective:
string
Read Only:
true
Indicates if the security group is effective. -
isReadOnly:
string
Read Only:
true
Indicates if the security group is read only. -
name:
string
The name of the security group.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the security group was last updated. This is a read-only property. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the security group. This is a read-only property. -
updatedByName:
string
The name of the user who last updated the security group.
Nested Schema : TypePermission
Type:
object
Title:
Show Source
TypePermission
-
objectType:
string
-
permissions:
object TypePermissions
Title:
TypePermissions
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : TypePermissions
Type:
object
Title:
Show Source
TypePermissions
-
type:
string
The asset's type in Eloqua. This is a read-only property.
400 Response
Bad request. See Status Codes for information about other possible HTTP status codes.
401 Response
Unauthorized. See Status Codes for information about other possible HTTP status codes.
403 Response
Forbidden. See Status Codes for information about other possible HTTP status codes.
404 Response
The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Examples
Update the user with Id #5:
PUT /api/REST/2.0/system/user/5
Content-Type: application/json
Request body:
{
"id": "5",
"name": "API User",
"defaultAccountViewId": "100003"
}
Response:
{
"type": "User",
"id": "5",
"createdAt": "1417806084",
"createdBy": "3",
"depth": "complete",
"description": "API User",
"folderId": "256",
"name": "API User",
"updatedAt": "1594823519",
"updatedBy": "9",
"address1": "",
"address2": "",
"betaAccess": [...],
"capabilities": [...],
"cellPhone": "",
"city": "",
"companyDisplayName": "CompanyName",
"companyUrl": "",
"country": "",
"crmUserNames": {
"type": "crmUserNames",
"MSDUserName": "",
"OSCUserName": "",
"SFDCUserName": "",
"SODUserName": ""
},
"crmUsername": "",
"defaultAccountViewId": "100003",
"defaultContactViewId": "100001",
"department": "",
"digitalSignatureId": "",
"emailAddress": "api.user@oracle.com",
"fax": "",
"federationId": "",
"firstName": "API",
"interfacePermissions": [...],
"isDisabled": "False",
"isUsingBrightenTemplate": "False",
"jobTitle": "",
"lastName": "User",
"loginName": "API.User",
"passwordExpires": "True",
"personalMessage": "",
"personalPhotoId": "",
"personalUrl": "",
"phone": "",
"preferences": {
"type": "UserPreferences",
"timezoneId": "64"
},
"productPermissions": [...],
"replyToAddress": "api.user@oracle.com",
"securityGroups": [...],
"senderDisplayName": "API User",
"senderEmailAddress": "api.user@oracle.com",
"ssoOnly": "False",
"state": "",
"typePermissions": [...],
"zipCode": ""
}