Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthChangeNativeUserPasswordRequest

Description

Changes the password for a native user.
Only call this for a non-authenticated session.
This request does not replace the functionality of [RpcAuthLoginRequest].

Properties

Name	JsonSchemaType	Description
actualPassword	string	Previous user password.
locale	string	Locale, used for error messages returned from this request. 4-letter ISO codes should be used, e.g. en_US.
mobilePhoneNumber	string	Mobile number to which the provisioning SMS should be sent. Ignored for repeated provisioning. Once the number is set, it can only be changed by disabling and re-enabling 2FA for the user.
newPassword	string	New user password.
otp	string	One time password, used in 2-factor authentication
requestProvisionSms	boolean	If true and 2FA is enabled, provisioning SMS will be sent to the user.
username	string	User login.

Dual message (request/response)

Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthChangeNativeUserPasswordResponse

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthChangeNativeUserPasswordRequest",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthChangeNativeUserPasswordRequest"
    ],
    "properties": {
        "Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthChangeNativeUserPasswordRequest": {
            "$ref": "#/definitions/RpcAuthChangeNativeUserPasswordRequest"
        }
    },
    "definitions": {
        "RpcAuthChangeNativeUserPasswordRequest": {
            "additionalProperties": false,
            "required": [
                "actualPassword",
                "locale",
                "newPassword",
                "username"
            ],
            "type": "object",
            "properties": {
                "actualPassword": {
                    "type": "string"
                },
                "locale": {
                    "type": "string"
                },
                "mobilePhoneNumber": {
                    "type": "string"
                },
                "newPassword": {
                    "pattern": ".{8}.*",
                    "type": "string"
                },
                "otp": {
                    "type": "string"
                },
                "requestProvisionSms": {
                    "type": "boolean"
                },
                "username": {
                    "pattern": "\\s*.{1,}\\s*",
                    "type": "string"
                }
            }
        }
    }
}