Jump to

• Request
• Response

Update User Password

patch

http://{host}:{port}/veridata/v1/services/admin/users/{Id}/password

Required Role: Administrator, CommandLineOperator

Update User Password

Request

Path Parameters

• Id(required): integer(int64)
  user ID

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• newPassword(required): string
  New Password.

{
    "type":"object",
    "properties":{
        "newPassword":{
            "type":"string",
            "description":"New Password."
        }
    },
    "required":[
        "newPassword"
    ],
    "example":{
        "newPassword":"Abcd@123"
    }
}

Example:

{
    "newPassword":"Abcd@123"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

User password updated successfully

400 Response

Bad Request.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 Response

Unauthorized.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 Response

Not Found.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 Response

Server Error.

Body ()

Root Schema : Error

Type: object

Show Source

• errCode: string
  Veridata Error Code.
• errMsg: string
  Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

Back to Top