Update a user account
patch
/hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}
Request
Path Parameters
-
GUID(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CredentialsEmailSentFlag: boolean
Title:
Credentials Email Sent
Maximum Length:30
Default Value:false
Indicates whether the user name and password credentials were sent to the user after the account was created. The default value is Yes. Valid values are Yes and No. -
PersonId: integer
(int64)
Title:
Person ID
Unique identifier of the person record linked to the user account. -
PersonNumber: string
Title:
Person Number
Maximum Length:30
Person number of the person record linked to the user account. -
SuspendedFlag: boolean
Title:
Suspended
Maximum Length:30
Indicates whether the user, as part of termination, is suspended. If suspended, the user can be reactivated. Valid values are Yes and No. -
userAccountRoles: array
User Account Roles
Title:
User Account Roles
The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained. -
Username: string
Title:
User Name
Maximum Length:100
User name, a unique identifier for a user's account.
Nested Schema : User Account Roles
Type:
array
Title:
User Account Roles
The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : userAccounts-userAccountRoles-item-patch-request
Type:
Show Source
object
-
RoleCode: string
Title:
Role Code
Maximum Length:240
Technical name used to search for a specific role.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : userAccounts-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the user account. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user account was created. -
CredentialsEmailSentFlag: boolean
Title:
Credentials Email Sent
Maximum Length:30
Default Value:false
Indicates whether the user name and password credentials were sent to the user after the account was created. The default value is Yes. Valid values are Yes and No. -
GUID: string
Title:
GUID
Maximum Length:64
Globally unique identifier for the user account. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user account was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the user account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Title:
Person ID
Unique identifier of the person record linked to the user account. -
PersonNumber: string
Title:
Person Number
Maximum Length:30
Person number of the person record linked to the user account. -
SuspendedFlag: boolean
Title:
Suspended
Maximum Length:30
Indicates whether the user, as part of termination, is suspended. If suspended, the user can be reactivated. Valid values are Yes and No. -
userAccountRoles: array
User Account Roles
Title:
User Account Roles
The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained. -
UserId: integer
(int64)
Title:
User ID
Unique identifier for the user. -
Username: string
Title:
User Name
Maximum Length:100
User name, a unique identifier for a user's account.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : User Account Roles
Type:
array
Title:
User Account Roles
The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : userAccounts-userAccountRoles-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the user account role assignment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user account role assignment was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user account role assignment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the user account role assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RoleCode: string
Title:
Role Code
Maximum Length:240
Technical name used to search for a specific role. -
RoleId: integer
(int64)
Title:
Role ID
Unique identifier of a role. -
UserRoleId: integer
(int64)
Title:
User Role ID
Unique identifier of the user role.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- autoprovisionRoles
-
Parameters:
- GUID:
$request.path.GUID
Triggers the roles autoprovisioning process on the selected user account. - GUID:
- resetPassword
-
Parameters:
- GUID:
$request.path.GUID
Resets the password to a user account. Initiating this custom action on the selected user account must trigger the password reset flow. - GUID:
- updatePassword
-
Parameters:
- GUID:
$request.path.GUID
Updates the password to a user account. Initiating the custom action on the selected user account must trigger the password update flow. - GUID:
- userAccountRoles
-
Parameters:
- GUID:
$request.path.GUID
The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained. - GUID:
Examples
The following example shows how to update a user account by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/userAccounts/8A8D68E5E062BAFCE050F50A9C4E9A63"
Example of Payload
The following is an example of the payload.
{ "Username": "John2019061002" }
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type: application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "UserId" : 300100185541354, "Username" : "John2019061002", "SuspendedFlag" : false, "PersonId" : 300100182158891, "PersonNumber" : "955160008191624", "CredentialsEmailSentFlag" : false, "GUID" : "8A8D68E5E062BAFCE050F50A9C4E9A63", "CreatedBy" : "HR_SPEC_ALL", "CreationDate" : "2019-06-10T19:31:32.399+00:00", "LastUpdatedBy" : "HR_SPEC_ALL", "LastUpdateDate" : "2019-06-10T19:41:34.005+00:00", "links": [ { ...} ] }