Jump to

• Request
• Response
• Examples

Get a User

get

/rest/v19/users/{partyNumber}

This endpoint retrieves information for a single user.

Request

Path Parameters

• partyNumber(required): string
  Party Number of the user

Query Parameters

• excludeLinks: string
  Exclude given link types from response
• expand: string
  Allows expansion of relationships.
• fields: string
  User fields to be returned in response.

Back to Top

Response

Supported Media Types

• application/json

Default Response

User details.

Body ()

Root Schema : User Details

Type: object

Title: User Details

User details of group.

Show Source

• firstName: string
  Title: User First Name

  First name of the user.
• lastName: string
  Title: User Last Name

  Last name of the user.
• login: string
  Title: User Login Id

  Login Id of the user.

{
    "type":"object",
    "properties":{
        "login":{
            "type":"string",
            "description":"Login Id of the user.",
            "title":"User Login Id"
        },
        "firstName":{
            "type":"string",
            "description":"First name of the user.",
            "title":"User First Name"
        },
        "lastName":{
            "type":"string",
            "description":"Last name of the user.",
            "title":"User Last Name"
        }
    },
    "title":"User Details",
    "description":"User details of group."
}

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": "[e-mail]",
  "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": "[e-mail]",
  "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": "[e-mail]",
  "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