Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthLoginRequired2FAException

Description

Exception returned by [RpcAuthLoginRequest] or [RpcAuthChangeNativeUserPasswordRequest] if the user would authenticate correctly (correct login/password), but 2 factor authentication is required.
Subsequent call to [RpcAuthLoginRequest] or [RpcAuthChangeNativeUserPasswordRequest] should be used to provide the 2FA information.

Properties

Name	JsonSchemaType	Description
mobilePhoneNumber	string	Phone number, to which the provisioning SMS will be sent (if requested by [RpcAuthLoginRequest] or [RpcAuthChangeNativeUserPasswordRequest]).
provisionedMobileAppUrl	string	URL to be used for provisioning (i.e. install the 2FA mobile application and get correct codes). This URL is only returned until the first successful 2FA authentication. String "provisioning-needed" will be returned if the user needs to enter phone number for his provisioning. After entering phone number, correct URL will be returned here.
twoFactorAuthType	enum of Era.Common.DataDefinition.Security.TwoFactorAuthType	Two factor auth type

Dual message (request/response)

No dual message.

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthLoginRequired2FAException",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthLoginRequired2FAException"
    ],
    "properties": {
        "Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthLoginRequired2FAException": {
            "$ref": "#/definitions/RpcAuthLoginRequired2FAException"
        }
    },
    "definitions": {
        "RpcAuthLoginRequired2FAException": {
            "additionalProperties": false,
            "type": "object",
            "properties": {
                "mobilePhoneNumber": {
                    "type": "string"
                },
                "provisionedMobileAppUrl": {
                    "type": "string"
                },
                "twoFactorAuthType": {
                    "enum": [
                        0,
                        1,
                        2
                    ]
                }
            }
        }
    }
}