Update a user
patch
/hcmRestApi/scim/Users/{id}
Update a user
Request
Path Parameters
-
id(required): string
The unique identifier of the user.
Supported Media Types
- */*
Root Schema : schema
Type:
Show Source
object
-
active: boolean
Title:
Active
Indicates the administrative status of the user. The service provider determines the definitive value for this attribute. For example, true indicates that the user is able to login, and false indicates that the user account is suspended. -
displayName: string
Title:
DisplayName
The display name of the user, usually the full name. -
emails: array
Emails
Title:
Emails
The e-mail addresses of the user. The service provider uses canonical form of these addresses, for example, bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical type values are work, home, and other. -
id: string
Title:
Id
Read Only:true
A unique identifier for the user resource in Oracle Fusion Cloud Applications. -
meta: object
Meta
Title:
Meta
The metadata of the user resource. -
name: object
Name
Title:
Name
The components of the user's name. This attribute may return:Full name as a single string Individual component attributes Both variants. The formatted version indicates how the component attributes are combined so that both variants describe the same name. -
password: string
Title:
Password
The clear text password of the user. This attribute is used to specify an initial password for new users and to reset password for existing users. The password attribute is never returned in response to a query. -
roles: array
Roles
Title:
Roles
The list of roles for users in Oracle Fusion Cloud Applications. -
schemas(required): array
Schemas
Title:
Schemas
The schema of the user resource. -
urn:scim:schemas:extension:fa:2.0:faUser: object
faUser-item
-
userName(required): string
Title:
UserName
A unique identifier for the user to authenticate with the service provider directly. This attribute is required.
Nested Schema : Emails
Type:
array
Title:
Emails
The e-mail addresses of the user. The service provider uses canonical form of these addresses, for example, bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical type values are work, home, and other.
Show Source
Nested Schema : Meta
Type:
object
Title:
Meta
The metadata of the user resource.
Nested Schema : Name
Type:
object
Title:
Name
The components of the user's name. This attribute may return:Full name as a single string Individual component attributes Both variants. The formatted version indicates how the component attributes are combined so that both variants describe the same name.
Nested Schema : Roles
Type:
array
Title:
Roles
The list of roles for users in Oracle Fusion Cloud Applications.
Show Source
Nested Schema : faUser-item
Type:
Show Source
object
-
accountType: string
Title:
AccountType
Read Only:true
The account type of a user to indicate person or party association. -
assignServiceAdminRoles: boolean
Title:
AssignServiceAdminRoles
Indicates if the service admin roles are assigned to the user. You can use this attribute to assign ORA_FND_DIAG_ADMINISTRATOR_JOB, ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOB, and ORA_FND_IT_SECURITY_MANAGER_JOB admin roles when you create or update a user. -
partyInformation: array
PartyInformation
Title:
PartyInformation
The party information associated with the user. -
userCategory: string
Title:
UserCategory
A user is associated with only one category, at any given time. The default user category value is DEFAULT. -
workerInformation: array
WorkerInformation
Title:
WorkerInformation
The worker information associated with the user.
Nested Schema : email-item
Type:
Show Source
object
-
primary: boolean
Title:
Primary
Indicates that this e-mail id is the primary address. This value is hard coded to true. -
type: string
Title:
Type
The type of e-mail id, which is hard coded to work. -
value: string
Title:
Value
The e-mail addresses of the user. The service provider uses canonical form of these addresses, for example, bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical type values are work, home, and other.
Nested Schema : role-item
Type:
Show Source
object
-
description: string
Title:
Description
Read Only:true
The description of the role. -
displayName: string
Title:
DisplayName
Read Only:true
The display name of the role. -
id: string
Title:
Id
Read Only:true
A list of ids for the roles that a user can belong to, through direct membership. -
value: string
Title:
Value
Read Only:true
A list of values for the roles.
Nested Schema : PartyInformation
Type:
array
Title:
PartyInformation
The party information associated with the user.
Show Source
Nested Schema : WorkerInformation
Type:
array
Title:
WorkerInformation
The worker information associated with the user.
Show Source
Nested Schema : partyInformation-item
Type:
Show Source
object
-
partyNumber: string
Title:
PartyNumber
Read Only:true
The party number associated with the user. -
PartyUsage: string
Title:
Party Usage
Read Only:true
The party usage associated with the user, for example, Supplier Contact,Partner Contact, and Customer Contact.
Nested Schema : workerInformation-item
Type:
Show Source
object
-
businessUnit: string
Title:
BusinessUnit
Read Only:true
The business unit to which the user belongs. -
department: string
Title:
Department
Read Only:true
The department to which the user belongs. -
job: string
Title:
Job
Read Only:true
The job title of the user. -
manager: string
Title:
Manager
Read Only:true
The manager name of the user. -
personNumber: string
Title:
PersonNumber
Read Only:true
The person number associated with the user.
Response
Supported Media Types
- application/json
200 Response
The following table describes the response for this task.
Root Schema : schema
Type:
Show Source
object
-
active: boolean
Title:
Active
Indicates the administrative status of the user. The service provider determines the definitive value for this attribute. For example, true indicates that the user is able to login, and false indicates that the user account is suspended. -
displayName: string
Title:
DisplayName
The display name of the user, usually the full name. -
emails: array
Emails
Title:
Emails
The e-mail addresses of the user. The service provider uses canonical form of these addresses, for example, bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical type values are work, home, and other. -
id: string
Title:
Id
Read Only:true
A unique identifier for the user resource in Oracle Fusion Cloud Applications. -
meta: object
Meta
Title:
Meta
The metadata of the user resource. -
name: object
Name
Title:
Name
The components of the user's name. This attribute may return:Full name as a single string Individual component attributes Both variants. The formatted version indicates how the component attributes are combined so that both variants describe the same name. -
password: string
Title:
Password
The clear text password of the user. This attribute is used to specify an initial password for new users and to reset password for existing users. The password attribute is never returned in response to a query. -
roles: array
Roles
Title:
Roles
The list of roles for users in Oracle Fusion Cloud Applications. -
schemas(required): array
Schemas
Title:
Schemas
The schema of the user resource. -
urn:scim:schemas:extension:fa:2.0:faUser: object
faUser-item
-
userName(required): string
Title:
UserName
A unique identifier for the user to authenticate with the service provider directly. This attribute is required.
Nested Schema : Emails
Type:
array
Title:
Emails
The e-mail addresses of the user. The service provider uses canonical form of these addresses, for example, bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical type values are work, home, and other.
Show Source
Nested Schema : Meta
Type:
object
Title:
Meta
The metadata of the user resource.
Nested Schema : Name
Type:
object
Title:
Name
The components of the user's name. This attribute may return:Full name as a single string Individual component attributes Both variants. The formatted version indicates how the component attributes are combined so that both variants describe the same name.
Nested Schema : Roles
Type:
array
Title:
Roles
The list of roles for users in Oracle Fusion Cloud Applications.
Show Source
Nested Schema : faUser-item
Type:
Show Source
object
-
accountType: string
Title:
AccountType
Read Only:true
The account type of a user to indicate person or party association. -
assignServiceAdminRoles: boolean
Title:
AssignServiceAdminRoles
Indicates if the service admin roles are assigned to the user. You can use this attribute to assign ORA_FND_DIAG_ADMINISTRATOR_JOB, ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOB, and ORA_FND_IT_SECURITY_MANAGER_JOB admin roles when you create or update a user. -
partyInformation: array
PartyInformation
Title:
PartyInformation
The party information associated with the user. -
userCategory: string
Title:
UserCategory
A user is associated with only one category, at any given time. The default user category value is DEFAULT. -
workerInformation: array
WorkerInformation
Title:
WorkerInformation
The worker information associated with the user.
Nested Schema : email-item
Type:
Show Source
object
-
primary: boolean
Title:
Primary
Indicates that this e-mail id is the primary address. This value is hard coded to true. -
type: string
Title:
Type
The type of e-mail id, which is hard coded to work. -
value: string
Title:
Value
The e-mail addresses of the user. The service provider uses canonical form of these addresses, for example, bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical type values are work, home, and other.
Nested Schema : role-item
Type:
Show Source
object
-
description: string
Title:
Description
Read Only:true
The description of the role. -
displayName: string
Title:
DisplayName
Read Only:true
The display name of the role. -
id: string
Title:
Id
Read Only:true
A list of ids for the roles that a user can belong to, through direct membership. -
value: string
Title:
Value
Read Only:true
A list of values for the roles.
Nested Schema : PartyInformation
Type:
array
Title:
PartyInformation
The party information associated with the user.
Show Source
Nested Schema : WorkerInformation
Type:
array
Title:
WorkerInformation
The worker information associated with the user.
Show Source
Nested Schema : partyInformation-item
Type:
Show Source
object
-
partyNumber: string
Title:
PartyNumber
Read Only:true
The party number associated with the user. -
PartyUsage: string
Title:
Party Usage
Read Only:true
The party usage associated with the user, for example, Supplier Contact,Partner Contact, and Customer Contact.
Nested Schema : workerInformation-item
Type:
Show Source
object
-
businessUnit: string
Title:
BusinessUnit
Read Only:true
The business unit to which the user belongs. -
department: string
Title:
Department
Read Only:true
The department to which the user belongs. -
job: string
Title:
Job
Read Only:true
The job title of the user. -
manager: string
Title:
Manager
Read Only:true
The manager name of the user. -
personNumber: string
Title:
PersonNumber
Read Only:true
The person number associated with the user.
Examples
The following example shows how to update a user by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/hcmRestApi/scim/Users/3DEC63ED61FD0863E050F00A081B15FF
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "schemas":[ "urn:scim:schemas:core:2.0:User" ], "active":false }
Example of Response Header
The following shows an example of the response header.
Status: HTTP/1.1 200 OK Content-Type : application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "id": "3DEC63ED61FD0863E050F00A081B15FF", "meta": { "created": "2016-10-20 12:36:21.000", "lastModified": "2016-10-20 12:46:41.000", "location": "http://<host>:<port>/hcmRestApi/scim/Users/3DEC63ED61FD0863E050F00A081B15FF" }, "schemas": [ "urn:scim:schemas:core:2.0:User" ], "externalId": "externalId12345:", "userName": "JONESK_OPERATIONS", "name": { "familyName": "Jones", "givenName": "Kerry" }, "displayName": "Kerry Jones", "preferredLanguage": "en", "emails": [ { "value": "J.K@oracle.com", "type": "W", "primary": true } ], "active": false }