Jump to

• Request
• Response
• Examples

Get Company User Details

get

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

This operation returns user details for a specific company user.

Request

Path Parameters

• companyName(required): string
  Company login name. For Host Company users, use _host. For Partner Organization users, use partner organization company login name.
• userName(required): string
  Login Id 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 shows how to returns user details for 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 
https://sitename.oracle.com/rest/v19/companies/_host/users/alicia.sans

Response Body Sample

 {
  "login": "alicia.sans",
  "isNotifyFax": false,
  "firstName": "Alicia",
  "lastName": "Sans",
  "jobTitle": "Representante de Ventas",
  "email": "[e-mail]",
  "partnerLogin": "john.dunbar",
  "externalSsoId": "[e-mail]",
  "separateShipAddr": false,
  "isNotifyEmail": true,
  "isWebServicesOnly": false,
  "dateModified": "2020-10-13T16:28:54.000Z",
  "dateAdded": "2018-05-07T14:15:38.000Z",
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/companies/_host/users/alicia.sans"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/companies/_host/users/alicia.sans/groups"
    }
  ],
  "type": {
    "value": "SALES_AGENT",
    "displayValue": "SalesAgent"
  },
  "language": {
    "value": "es_ES",
    "displayValue": "Spanish"
  },
  "currency": {
    "value": "EUR",
    "displayValue": "Euro"
  },
  "numberFormat": {
    "value": 0,
    "displayValue": "####.##"
  },
  "timeZone": {
    "value": "America/New_York",
    "displayValue": "(GMT-5:00 GMT-4:00) New York"
  },
  "units": {
    "value": 0,
    "displayValue": "System Default"
  },
  "dateFormat": {
    "value": 2,
    "displayValue": "dd/MM/yyyy HH:mm"
  },
  "status": {
    "value": 1,
    "displayValue": "Active"
  },
  "enabledForSso": {
    "value": "SSO_ENABLED",
    "displayValue": "Enabled for SSO"
  }
}

Back to Top