Jump to

• Request
• Response
• Examples

Update a user's password

put

/api/rest/2.0/system/user/{id}/password

Updates a user's password.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  The id of the user to update the password

Body ()

The request body defines the details of the request

Root Schema : UserPassword

Type: object

Title: UserPassword

Show Source

• mustChangePassword: string
  Boolean to determine whether the user must change their password upon logging in.
• password: string
  The user's password.
• type: string
  The asset's type in Eloqua. This is a read-only property.

{
    "title":"UserPassword",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "password":{
            "type":"string",
            "description":"The user's password."
        },
        "mustChangePassword":{
            "type":"string",
            "description":"Boolean to determine whether the user must change their password upon logging in."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.

Back to Top

Examples

For a user with the user ID #5, update the user's password:

PUT /api/REST/2.0/system/user/5/password
Content-Type: application/json 
			

Request body:

Update the user's password, and force the user to change their password when logging in.

{
  "password": "Eloqua123!",
  "mustChangePassword": true
}
			

Response:

200 OK
			

Back to Top