Updated on 2023-09-27 GMT+08:00

Changing the Password (Extended)

Prerequisites

  • The agent has signed in.

Description

This interface is used by an agent to change the password.

1. The new password can contain 8 to 32 characters.

2. The new password cannot contain two or more consecutive identical characters.

3. The new password cannot contain three or more consecutive characters in workno.

4. The new password must contain three or more types of the following characters: uppercase letters, lowercase letters, digits, and special characters.

5. The new password must be different from the last five (the quantity is configurable on the WAS) passwords.

Interface Method

The request method must be set to POST. This interface supports only the POST method.

URI

https://ip:port/agentgateway/resource/onlineagent/{agentid}/modifyaccountpwdex

In the URL, ip indicates the IP address of the CC-Gateway server, and port indicates the HTTPS port number of the CC-Gateway server.

Table 1 Parameter in the URI

No.

Parameter

Data Type

Mandatory (Yes/No)

Description

1

agentid

string

Yes

Agent ID. The value ranges from 101 to 59999.

Method Name in Logs

modifyAccountPwdEx

Request Description

  • Message header
    Table 2 Parameters in the request message header

    No.

    Parameter

    Value Type

    Mandatory (Yes/No)

    Description

    1

    Content-Type

    string

    Yes

    Coding mode of the message body. The default value is application/json; charset=UTF-8.

    2

    Guid

    string

    Yes

    GUID returned by the sign-in interface during static authentication (AUTHMODE is set to 1) or GUID returned by the polling event query interface during dynamic authentication (AUTHMODE is set to 2).

  • Message body
    Table 3 Parameters in the message body

    No.

    Parameter

    Value Type

    Mandatory (Yes/No)

    Description

    1

    oldPassword

    string

    Yes

    Old password. The value is a string of 8 to 32 characters.

    2

    newPassword

    string

    Yes

    New password. The value is a string of 8 to 32 characters.

Response Description

Table 4 Parameters in the message body

No.

Parameter

Value Type

Description

1

message

string

Description.

2

retcode

string

Error code. The options are as follows:

0: success

Other values: failure

3

result

object

Reserved field.

Triggered Event

  • None

Error Code

  • 000-002
  • 100-006
  • 100-007

Example

  • Message header
    Content-Type:application/json; charset=UTF-8
    Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • Request parameter
    {
        "oldPassword": "*******",
        "newPassword": "########"
    }
  • Response parameter
    {
      "result": {},
      "message": "success",
      "retcode": "0"
    }