Jump to

• Request
• Response

Get a user

get

/learn.rest/v1/users/{userId}

Request

Path Parameters

• userId: number
  Unique identifier of User.

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

user fetched

Body ()

Root Schema : User

Type: object

User response object

Show Source

• city(optional): string
  The city of the user.
• company(optional): string
  The User's place of work.
• country(optional): string
  The country of the user.
• createdDate(optional): string(datetime)
  Date the users created.
• department(optional): string
  The User's department.
• email(optional): string
  The User's email address.
• email2(optional): string
  The secondary email address.
• employeeId(optional): string
  Email address of the employee.
• fax(optional): string
  The fax number of the user.
• firstName(optional): string
  Description of the user.
• gender(optional): string
  Allowed Values: [ "male", "female" ]

  User gender. Enum for gender are: male, female
• id(optional): number
• includeInSearchFlag(optional): boolean
  Default Value: false

  Specifies whether the user will be included in searches.
• jobTitle(optional): string
  The User's job title.
• lastAccesedDate(optional): string(datetime)
  The last accessed date of the user record.
• lastName(optional): string
  Description of the user.
• lastUpdatedBy(optional): array lastUpdatedBy
  The person who last updated the user record.
• lastUpdatedByUserId(optional): number
  The user who last updated the user record.
• lastUpdatedDate(optional): string(datetime)
  The last updated date of the user record.
• managerName(optional): string
  The User's manager's name.
• officeName(optional): string
  The User's office.
• pager(optional): string
  The pager number of the user.
• pagerInteractive(optional): string
  The User's interactive pager number.
• participatesInDaylight(optional): boolean
  Default Value: true

  Specifies whether the user's timezone observes daylight savings
• passwordValidUntilDate(optional): string
  Date until which the password is valid for a user.
• phoneDaytime(optional): string
  The day time number of the user.
• phoneEvening(optional): string
  The evening number of the user.
• phoneMobile(optional): string
  The mobile number of the user.
• postalCode(optional): string
  The postal code of the user.
• profession(optional): string
  Profession of the user.
• ssn(optional): string
  The user's social security number.
• state(optional): string
  The state of the user.
• street1(optional): string
  The street text address of the user.
• street2(optional): string
  The street text address of the user.
• timeZone(optional): string
  The user's timezone
• username(optional): string
  Username of the user

{
    "type":"object",
    "description":"User response object",
    "properties":{
        "id":{
            "type":"number"
        },
        "username":{
            "type":"string",
            "description":"Username of the user"
        },
        "firstName":{
            "type":"string",
            "description":"Description of the user."
        },
        "lastName":{
            "type":"string",
            "description":"Description of the user."
        },
        "street1":{
            "type":"string",
            "description":"The street text address of the user."
        },
        "street2":{
            "type":"string",
            "description":"The street text address of the user."
        },
        "city":{
            "type":"string",
            "description":"The city of the user."
        },
        "postalCode":{
            "type":"string",
            "description":"The postal code of the user."
        },
        "state":{
            "type":"string",
            "description":"The state of the user."
        },
        "country":{
            "type":"string",
            "description":"The country of the user."
        },
        "phoneDaytime":{
            "type":"string",
            "description":"The day time number of the user."
        },
        "phoneEvening":{
            "type":"string",
            "description":"The evening number of the user."
        },
        "phoneMobile":{
            "type":"string",
            "description":"The mobile number of the user."
        },
        "fax":{
            "type":"string",
            "description":"The fax number of the user."
        },
        "pager":{
            "type":"string",
            "description":"The pager number of the user."
        },
        "pagerInteractive":{
            "type":"string",
            "description":"The User's interactive pager number."
        },
        "email":{
            "type":"string",
            "description":"The User's email address."
        },
        "email2":{
            "type":"string",
            "description":"The secondary email address."
        },
        "gender":{
            "type":"string",
            "description":"User gender. Enum for gender are: male, female",
            "enum":[
                "male",
                "female"
            ]
        },
        "ssn":{
            "type":"string",
            "description":"The user's social security number."
        },
        "employeeId":{
            "type":"string",
            "description":"Email address of the employee."
        },
        "company":{
            "type":"string",
            "description":"The User's place of work."
        },
        "officeName":{
            "type":"string",
            "description":"The User's office."
        },
        "department":{
            "type":"string",
            "description":"The User's department."
        },
        "jobTitle":{
            "type":"string",
            "description":"The User's job title."
        },
        "profession":{
            "type":"string",
            "description":"Profession of the user."
        },
        "managerName":{
            "type":"string",
            "description":"The User's manager's name."
        },
        "createdDate":{
            "type":"string",
            "format":"datetime",
            "description":"Date the users created."
        },
        "lastAccesedDate":{
            "type":"string",
            "format":"datetime",
            "description":"The last accessed date of the user record."
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"datetime",
            "description":"The last updated date of the user record."
        },
        "lastUpdatedByUserId":{
            "type":"number",
            "description":"The user who last updated the user record."
        },
        "lastUpdatedBy":{
            "description":"The person who last updated the user record.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItems"
            }
        },
        "passwordValidUntilDate":{
            "type":"string",
            "description":"Date until which the password is valid for a user."
        },
        "includeInSearchFlag":{
            "type":"boolean",
            "default":false,
            "description":"Specifies whether the user will be included in searches."
        },
        "timeZone":{
            "type":"string",
            "description":"The user's timezone"
        },
        "participatesInDaylight":{
            "type":"boolean",
            "default":true,
            "description":"Specifies whether the user's timezone observes daylight savings"
        }
    },
    "example":{
        "id":112870,
        "username":"abc",
        "nickname":"",
        "firstName":"abc",
        "lastName":"def",
        "street1":"4500 Oracle Ln",
        "street2":"Suite 400",
        "city":"Redwood Shores",
        "postalCode":"94566",
        "state":"CA",
        "country":"US",
        "phoneDaytime":"614.266.2084Ex.0000",
        "phoneEvening":"614-638-5648",
        "phoneMobile":"614.266.2084",
        "fax":"",
        "pager":"",
        "pagerInteractive":"",
        "email":"[e-mail]",
        "email2":"[e-mail]",
        "gender":"male",
        "ssn":"",
        "employeeId":"Test EEID for abc",
        "company":"Oracle",
        "officeName":"",
        "department":"",
        "jobTitle":"Job Manager",
        "profession":"",
        "managerName":"",
        "createdDate":"2011-12-01T16:36:00-05:00",
        "lastAccessedDate":"2018-12-20T12:08:00-05:00",
        "lastUpdatedDate":"2018-10-08T10:48:31-04:00",
        "lastUpdatedByUserId":112870,
        "lastUpdatedBy":{
            "links":[
                {
                    "rel":"canonical",
                    "href":"{url}/learn.rest/v1/users/112870"
                }
            ]
        },
        "hireDate":"2018-06-03T00:00:00",
        "lastHireDate":"2007-04-11T00:00:00",
        "lastJobChangeDate":"2012-07-02T00:00:00",
        "certificationExpirationDate":"2017-11-17T00:00:00",
        "includeInSearchFlag":true,
        "timeZone":"Eastern Standard Time",
        "participatesInDaylight":true,
        "memberships":{
            "links":[
                {
                    "rel":"canonical",
                    "href":"{url}/learn.rest/v1/users/112870/memberships"
                }
            ]
        },
        "links":[
            {
                "rel":"canonical",
                "href":"{url}/learn.rest/v1/users/112870"
            }
        ]
    },
    "xml":{
        "name":"User"
    }
}

Example:

{
    "id":112870,
    "username":"abc",
    "nickname":"",
    "firstName":"abc",
    "lastName":"def",
    "street1":"4500 Oracle Ln",
    "street2":"Suite 400",
    "city":"Redwood Shores",
    "postalCode":"94566",
    "state":"CA",
    "country":"US",
    "phoneDaytime":"614.266.2084Ex.0000",
    "phoneEvening":"614-638-5648",
    "phoneMobile":"614.266.2084",
    "fax":"",
    "pager":"",
    "pagerInteractive":"",
    "email":"[e-mail]",
    "email2":"[e-mail]",
    "gender":"male",
    "ssn":"",
    "employeeId":"Test EEID for abc",
    "company":"Oracle",
    "officeName":"",
    "department":"",
    "jobTitle":"Job Manager",
    "profession":"",
    "managerName":"",
    "createdDate":"2011-12-01T16:36:00-05:00",
    "lastAccessedDate":"2018-12-20T12:08:00-05:00",
    "lastUpdatedDate":"2018-10-08T10:48:31-04:00",
    "lastUpdatedByUserId":112870,
    "lastUpdatedBy":{
        "links":[
            {
                "rel":"canonical",
                "href":"{url}/learn.rest/v1/users/112870"
            }
        ]
    },
    "hireDate":"2018-06-03T00:00:00",
    "lastHireDate":"2007-04-11T00:00:00",
    "lastJobChangeDate":"2012-07-02T00:00:00",
    "certificationExpirationDate":"2017-11-17T00:00:00",
    "includeInSearchFlag":true,
    "timeZone":"Eastern Standard Time",
    "participatesInDaylight":true,
    "memberships":{
        "links":[
            {
                "rel":"canonical",
                "href":"{url}/learn.rest/v1/users/112870/memberships"
            }
        ]
    },
    "links":[
        {
            "rel":"canonical",
            "href":"{url}/learn.rest/v1/users/112870"
        }
    ]
}

Nested Schema : lastUpdatedBy

Type: array

The person who last updated the user record.

Show Source

• Array of: object UserLinkItems
  Link to user items.

{
    "description":"The person who last updated the user record.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItems"
    }
}

Nested Schema : UserLinkItems

Type: object

Link to user items.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/users/456
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "description":"Link to user items.",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/users/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/users/456"
}

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

404 Response

Resource not found.

500 Response

Internal server error.

Back to Top