Era.Common.NetworkMessage.ConsoleApi.Security.RpcModifyTwoFactorAuthenticationRequest

Description

Request for enabling/disabling of two factor authentication (2FA).

Properties

Name	JsonSchemaType	Description
authType	enum of Era.Common.DataDefinition.Security.TwoFactorAuthType	Two factor authentication type being used (ESA/Third-party).
enable	boolean	If true, 2FA will be enabled. If false, 2FA will be disabled.
isDomainGroup	boolean	If true, then userOrGroupUuid is a domain group UUID. If false, then userOrGroupUuid is a user (native or domain) UUID.
unlock	boolean	If true, 2FA will be unlocked (after the user tried wrong OTP for too many times). If unlock is true, then enable has to be true as well.
userOrGroupUuid	reference to Era.Common.DataDefinition.Common.Uuid	UUID of the group/user, for which 2FA should be enabled/disabled.

Dual message (request/response)

Era.Common.NetworkMessage.ConsoleApi.Security.RpcModifyTwoFactorAuthenticationResponse

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.Common.NetworkMessage.ConsoleApi.Security.RpcModifyTwoFactorAuthenticationRequest",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.NetworkMessage.ConsoleApi.Security.RpcModifyTwoFactorAuthenticationRequest"
    ],
    "properties": {
        "Era.Common.NetworkMessage.ConsoleApi.Security.RpcModifyTwoFactorAuthenticationRequest": {
            "$ref": "#/definitions/RpcModifyTwoFactorAuthenticationRequest"
        }
    },
    "definitions": {
        "RpcModifyTwoFactorAuthenticationRequest": {
            "additionalProperties": false,
            "required": [
                "enable",
                "isDomainGroup",
                "unlock",
                "userOrGroupUuid"
            ],
            "type": "object",
            "properties": {
                "authType": {
                    "enum": [
                        0,
                        1,
                        2
                    ]
                },
                "enable": {
                    "type": "boolean"
                },
                "isDomainGroup": {
                    "type": "boolean"
                },
                "unlock": {
                    "type": "boolean"
                },
                "userOrGroupUuid": {
                    "$ref": "Era.Common.DataDefinition.Common.Uuid#/definitions/Uuid"
                }
            }
        }
    }
}