Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthServerApiLoginResponse

Description

Response to [RpcAuthServerApiLoginRequest].

Properties

Name	JsonSchemaType	Description
deviceToken	string	Device token to be stored as cookie in browser to "remember device" when using 2FA
failureReason	string
refreshToken	reference to Era.Common.DataDefinition.Security.AuthIssuedToken
secondFactorRequirement	reference to Era.Common.DataDefinition.Security.SecondFactorRequirement
sessionToken	reference to Era.Common.DataDefinition.Security.AuthIssuedToken
status	enum of Era.Common.DataDefinition.Security.LoginStatusType
userUuid	reference to Era.Common.DataDefinition.Common.Uuid	UUID of the logged in user.

Dual message (request/response)

Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthServerApiLoginRequest

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthServerApiLoginResponse",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthServerApiLoginResponse"
    ],
    "properties": {
        "Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthServerApiLoginResponse": {
            "$ref": "#/definitions/RpcAuthServerApiLoginResponse"
        }
    },
    "definitions": {
        "RpcAuthServerApiLoginResponse": {
            "additionalProperties": false,
            "required": [
                "status"
            ],
            "type": "object",
            "properties": {
                "deviceToken": {
                    "type": "string"
                },
                "failureReason": {
                    "type": "string"
                },
                "refreshToken": {
                    "$ref": "Era.Common.DataDefinition.Security.AuthIssuedToken#/definitions/AuthIssuedToken"
                },
                "secondFactorRequirement": {
                    "$ref": "Era.Common.DataDefinition.Security.SecondFactorRequirement#/definitions/SecondFactorRequirement"
                },
                "sessionToken": {
                    "$ref": "Era.Common.DataDefinition.Security.AuthIssuedToken#/definitions/AuthIssuedToken"
                },
                "status": {
                    "enum": [
                        0,
                        1,
                        2,
                        3,
                        4,
                        5,
                        6,
                        7
                    ]
                },
                "userUuid": {
                    "$ref": "Era.Common.DataDefinition.Common.Uuid#/definitions/Uuid"
                }
            }
        }
    }
}