> Expert > Tools & Utilities > Developer Tools > REST API > REST API Reference > User Operations

REST API - POST User Account Management

This operation updates the credentials for a user account.

Request

Syntax

Send the request using either XML or JSON:

  • XML

     
    POST <webservice>/User/AccountManagement HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>
Content-type: application/xml
<update_user_credentials.xml>

  • JSON

     
    POST <webservice>/User/AccountManagement HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>
Content-type: application/json
<update_user_credentials.json>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Header

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Content-type

The media type contained in the request body.

Request Body

Download the XML or JSON file required for this request: update_user_credentials.xml or update_user_credentials.json. The following table displays the parameters for the request body.

Parameter

Description

Element

preview

The option to preview the changes to the user credentials.

Valid values are:

  • 1, to see a preview of the changes

  • 0, to update the credentials

GuiServer_ModifyCredsReq

reason

Text to explain why the credentials were changed. This information appears in the Audit Trail report.

GuiServer_ModifyCredsReq

skipPasswordCheck

The option to not require the old password before allowing a new password to be set.

Valid values are:

  • 1, to not validate the old password

  • 0, to validate the old password before allowing a new password to be set.

GuiServer_ModifyCredsReq

password

The current password for the user account.

oldCredentials

userName

The current user name for the user account.

oldCredentials

password

The new password for the user account.

The password must be in plain text in an XML request and Base64 encoded in a JSON request.

newCredentials

userName

The user name for the user account.

You can keep the current user name or update the user name.

newCredentials

_type_

Valid value is 2.

associations

Response

Response Parameters

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

  • 0, successful completion.

  • 2, a failure.

  • a specific error code.

App_GenericResp

errorMessage

The description of the error code. Not all error codes have an error message.

App_GenericResp

changes

If the preview attribute is set to 1 (true), a preview of your changes is displayed.

credentialChanges

Examples

Sample Request

POST <webservice>/User/AccountManagement HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<GuiServer_ModifyCredsReq preview="0" reason="" skipPasswordCheck="0"> <processinginstructioninfo/> <credsInfo> <oldCredentials password="Password001" userName="prodcert\admin"/> <newCredentials password="Password002" userName="prodcert\admin"/> <associations _type_="2"/> </credsInfo>
</GuiServer_ModifyCredsReq>

Sample Response

The response when the credentials are changed (preview attribute is set to 0 (false)):

<App_GenericResp errorMessage="User names/Passwords have been updated.  Consult Audit Trail for details." errorCode="0" />

The response when the preview attribute is set to 1 (true):

<GuiServer_ModifyCredsResp> <credentialChanges changes="UNC path user password"> <entities> <entity subclientId="34" applicationId="33" clientName="pmirje-server" backupsetId="28" instanceId="1" clientId="2" subclientName="default" backupsetName="cred_test_0" instanceName="DefaultInstanceName" _type_="7" appName="File System" /> </entities> </credentialChanges> <credentialChanges changes="User password for [password]"> <entities> <credEntity _type_="174" credentialId="11" credentialName="prd_test001" /> </entities> </credentialChanges>
</GuiServer_ModifyCredsResp>

Loading...