Get a User

get

/rest/v19/users/{partyNumber}

Use this new endpoint to retrieve information for a single user.

Request

Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

Default Response

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

The following example returns details about a specific user by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/users/935719302534024740

Response Body Sample

{
  "login": "simon.watts",
  "isNotifyFax": false,
  "firstName": "Simon",
  "jobTitle": "Sales Manager Administrator",
  "email": "simon.watts@yourcompany.com",
  "phone": "2622622627",
  "fax": "2622622655",
  "billLastName": "Watts",
  "billCompany": "abc",
  "billCompany2": "jkl",
  "billAddress1": "Address",
  "billAddress2": "Address",
  "billCity": "City",
  "billStateProvince": "Illinois",
  "billZip": "23434",
  "billCountry": "United States",
  "billPhone": "457657657",
  "billFax": "657657",
  "billEmail": "vs_eczw@companyemail.com",
  "shipFirstName": "Simon",
  "shipLastName": "Watts",
  "shipCompany": "B",
  "shipCompany2": "B",
  "shipAddress1": "Address",
  "shipAddress2": "Address",
  "shipCity": "City",
  "shipStateProvince": "California",
  "shipZip": "345435",
  "shipCountry": "United States",
  "shipPhone": "345435",
  "shipFax": "235435",
  "shipEmail": "vs@yourcompany.com",
  "separateShipAddr": false,
  "isNotifyEmail": true,
  "isUserAdminPermEnabled": true,
  "isWebServicesOnly": false,
  "isAccessAdminPermEnabled": true,
  "isProxyPermEnabled": true,
  "partyId": 935719302534024740,
  "partyNumber": "935719302534024740",
  "dateModified": "2024-05-13T23:02:43.000Z",
  "dateAdded": "2024-05-13T23:02:42.000Z",
  "links": [{
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v19/users/935719302534024740"
    }, {
      "rel": "child",
      "href": "http://sitename.oracle.com/rest/v19/users/935719302534024740/groups"
    }
  ],
  "type": {
    "value": "FULL_ACCESS",
    "displayValue": "FullAccess"
  },
  "language": {
    "value": "en_US",
    "displayValue": "English"
  },
  "currency": {
    "value": "USD",
    "displayValue": "US Dollar"
  },
  "numberFormat": {
    "value": 1,
    "displayValue": "####,##"
  },
  "timeZone": {
    "value": "America/Los_Angeles",
    "displayValue": "(GMT-8:00 GMT-7:00) Los Angeles"
  },
  "units": {
    "value": 1,
    "displayValue": "English"
  },
  "dateFormat": {
    "value": 16,
    "displayValue": "dd/MM/yyyy h:mm a"
  },
  "status": {
    "value": 1,
    "displayValue": "Active"
  },
  "enabledForSso": {
    "value": "SSO_ENABLED",
    "displayValue": "Enabled for SSO"
  },
  "company": {
    "name": "VisionServices",
    "loginName": "visionservices1"
  }
}
Back to Top