Update Company User

patch

/rest/v19/companies/{companyName}/users/{userName}

This operation applies changes to an existing user.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : user-request
Type: object
Show Source
Nested Schema : Access Permissions
Type: object
Title: Access Permissions
Access Permissions of the user
Show Source
Nested Schema : Currency
Type: object
Title: Currency
Currency preference of user. Value holds currency code
Show Source
Nested Schema : Date Format
Type: object
Title: Date Format
User preferred date time format
Show Source
Nested Schema : Enabled For SSO
Type: object
Title: Enabled For SSO
Enabled For SSO
Show Source
Nested Schema : Groups
Type: object
Title: Groups
Groups to which the user belongs
Show Source
Nested Schema : Language
Type: object
Title: Language
Language preference of user. Value holds language code
Show Source
Nested Schema : Number Format
Type: object
Title: Number Format
Preferred number format of user
Show Source
Nested Schema : Status
Type: object
Title: Status
Status of the user
Show Source
Nested Schema : TimeZone of user
Type: object
Title: TimeZone of user
User preferred timezone
Show Source
Nested Schema : Type
Type: object
Title: Type
Type of the user
Show Source
Nested Schema : Units
Type: object
Title: Units
User preferred units
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Access Permission
Type: object
Title: Access Permission
User access bits information
Show Source
  • Title: Has Access
    Flag to determine if user has access to the restricted entity
  • Title: Restricted Entity Name
    Name of the entity to which access restrictions apply
  • Title: Type
    Type of the restricted entity. Possible values productFamily, supportedProductFamily and dataTableFolder
  • Title: Restricted Entity Variable Name
    Variable name of the entity to which access restrictions apply
Nested Schema : items
Type: array
Show Source
Nested Schema : Group
Type: object
Title: Group
User group information
Show Source
Back to Top

Response

Supported Media Types

Default Response

Updated User details
Body ()
Root Schema : user
Type: object
Show Source
Nested Schema : Access Permissions
Type: object
Title: Access Permissions
Access Permissions of a user
Show Source
Nested Schema : Company details
Type: object
Title: Company details
User Company details. Applicable only for Users Across Companies
Show Source
Nested Schema : Currency
Type: object
Title: Currency
Currency preference of user. Value holds currency code
Show Source
Nested Schema : Date Format
Type: object
Title: Date Format
User preferred date time format
Show Source
Nested Schema : Enabled For SSO
Type: object
Title: Enabled For SSO
Enabled For SSO
Show Source
Nested Schema : Groups
Type: object
Title: Groups
Groups to which the user belongs
Show Source
Nested Schema : Language
Type: object
Title: Language
Language preference of user. Value holds language code
Show Source
Nested Schema : Number Format
Type: object
Title: Number Format
Preferred number format of user
Show Source
Nested Schema : Status
Type: object
Title: Status
Status of the user
Show Source
Nested Schema : TimeZone of user
Type: object
Title: TimeZone of user
User preferred timezone
Show Source
Nested Schema : Type
Type: object
Title: Type
Type of the user
Show Source
Nested Schema : Units
Type: object
Title: Units
User preferred units
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Access Permission
Type: object
Title: Access Permission
User access bits information
Show Source
  • Title: Has Access
    Flag to determine if user has access to the restricted entity
  • Title: Restricted Entity Name
    Name of the entity to which access restrictions apply
  • Title: Type
    Type of the restricted entity. Possible values productFamily, supportedProductFamily and dataTableFolder
  • Title: Restricted Entity Variable Name
    Variable name of the entity to which access restrictions apply
Nested Schema : items
Type: array
Show Source
Nested Schema : Group
Type: object
Title: Group
User group information
Show Source
Back to Top

Examples

This operation applies changes to an existing user by submitting a PATCH request to the REST resource using curl -H "Authorization: Bearer <token>" For more information about cURL, see Use cURL.

curl - X PATCH -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/companies/abcCo/users/AAP39

Request Body Sample

{
  "type": {
    "value": "FULL_ACCESS",
    "displayValue": "FullAccess"
  },
  "language": {
    "value": "en_US",
    "displayValue": "English"
  },
  "currency": {
    "value": "USD",
    "displayValue": "US Dollar"
  },
  "status": {
    "value": 1,
    "displayValue": "Active"
  },
  "enabledForSso": {
    "value": "SSO_ENABLED",
    "displayValue": "Enabled for SSO"
  }
}

Note: The display value is optional in the sample above. For example, the following sample is also valid.

{
  "type": {
    "value": "FULL_ACCESS"
  },
  "language": {
    "value": "en_US"
  },
  "currency": {
    "value": "USD"
  },
  "status": {
    "value": 1
  },
  "enabledForSso": {
    "value": "SSO_ENABLED"
  }
}
Back to Top