Jump to

• Request
• Response

Update subset of properties of a user

patch

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

Request

Supported Media Types

• application/json

Path Parameters

• userId(required): number
  Unique identifier of User.

Body ()

User object that needs to be updated

Root Schema : User

Type: object

Show Source

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

  User gender. Enum for gender are: male, female
• includeInSearchFlag: boolean
  Default Value: false

  Whether the user created should be visible in searches
• jobTitle: string
  The User's job title.
• lastName: string
  Description of the user.
• managerName: string
  The User's manager's name.
• officeName: string
  The User's office.
• pager: string
  The pager number of the user.
• pagerInteractive: string
  The User's interactive pager number.
• participatesInDaylight: boolean
  Default Value: true

  Whether the user's timezone should observe daylight savings
• passwordValidUntilDate: string
  The date until which the password is valid.
• phoneDaytime: string
  The day time number of the user.
• phoneEvening: string
  The evening number of the user.
• phoneMobile: string
  The mobile number of the user.
• postalCode: string
  The postal code of the user.
• profession: string
• ssn: string
  The user's social security number.
• state: string
  The state of the user.
• street1: string
  The street text address of the user.
• street2: string
  The street text address of the user.
• timeZone: string
  The timezone for the user
• username: string
  Username of the user

{
    "type":"object",
    "properties":{
        "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"
        },
        "managerName":{
            "type":"string",
            "description":"The User's manager's name."
        },
        "passwordValidUntilDate":{
            "type":"string",
            "description":"The date until which the password is valid."
        },
        "includeInSearchFlag":{
            "type":"boolean",
            "default":false,
            "description":"Whether the user created should be visible in searches"
        },
        "timeZone":{
            "type":"string",
            "description":"The timezone for the user"
        },
        "participatesInDaylight":{
            "type":"boolean",
            "default":true,
            "description":"Whether the user's timezone should observe daylight savings"
        }
    },
    "example":{
        "username":"cwallace",
        "firstName":"Chris",
        "lastName":"Wallace",
        "street1":"500 Oracle Parkway",
        "street2":"suite 500",
        "city":"Redwood Shores",
        "state":"CA",
        "postalCode":"94065",
        "country":"US",
        "officeName":"HQ",
        "gender":"male",
        "includeInSearchFlag":true,
        "jobTitle":"Product Manager",
        "managerName":"n/a",
        "pagerInteractive":"n/a",
        "ssn":"n/a",
        "email2":"n/a",
        "pager":"n/a",
        "company":"Oracle",
        "fax":"n/a",
        "department":"Product Development",
        "phoneEvening":"n/a",
        "email":"[e-mail]",
        "phoneDaytime":"+1.650.506.7000",
        "profession":"Product Management",
        "phoneMobile":"+1.800.392.2999",
        "employeeId":"n/a",
        "passwordValidUntilDate":"2016-10-12T11:00:00-04:00",
        "timeZone":"Eastern Standard Time",
        "participatesInDaylight":true
    },
    "xml":{
        "name":"User"
    }
}

Example:

{
    "username":"cwallace",
    "firstName":"Chris",
    "lastName":"Wallace",
    "street1":"500 Oracle Parkway",
    "street2":"suite 500",
    "city":"Redwood Shores",
    "state":"CA",
    "postalCode":"94065",
    "country":"US",
    "officeName":"HQ",
    "gender":"male",
    "includeInSearchFlag":true,
    "jobTitle":"Product Manager",
    "managerName":"n/a",
    "pagerInteractive":"n/a",
    "ssn":"n/a",
    "email2":"n/a",
    "pager":"n/a",
    "company":"Oracle",
    "fax":"n/a",
    "department":"Product Development",
    "phoneEvening":"n/a",
    "email":"[e-mail]",
    "phoneDaytime":"+1.650.506.7000",
    "profession":"Product Management",
    "phoneMobile":"+1.800.392.2999",
    "employeeId":"n/a",
    "passwordValidUntilDate":"2016-10-12T11:00:00-04:00",
    "timeZone":"Eastern Standard Time",
    "participatesInDaylight":true
}

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Resource updated.

400 Response

Request has incorrect syntax or does not contain a field that is required.

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