Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthLoginRequest
Description
Authenticates a user for current connection and creates a new session. After successful call, the user is authenticated for this network connection and may send requests corresponding to the user's access rights.
Properties
Name |
JsonSchemaType |
Description |
connectedFrom |
reference to Era.Common.DataDefinition.Network.Connection |
The address, from which the user connected. This information is not used during authentication, but may be logged and displayed to the user. |
isDomainUser |
boolean |
Set to false for native users, true for domain users. |
locale |
string |
Locale to be used for the new session. 4-letter ISO codes should be used, e.g. en_US. |
loginOneTimeToken |
string |
This is alternative to username, password. You can use this to login, this token was retrieved by RpcGenerateLoginOneTimeToken. If this is set username and password are ignored however they must be set to empty string (because of the required specifier) |
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. |
otp |
string |
One time password or device token, used in 2-factor authentication |
password |
string |
User password. |
rememberDevice |
boolean |
If true and 2FA is enabled, a token for given user and device will be generated |
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.RpcAuthLoginResponse |
Referenced in messages
No references.JsonSchema
{
"title": "Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthLoginRequest",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"required": [
"Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthLoginRequest"
],
"properties": {
"Era.Common.NetworkMessage.ConsoleApi.SessionManagement.RpcAuthLoginRequest": {
"$ref": "#/definitions/RpcAuthLoginRequest"
}
},
"definitions": {
"RpcAuthLoginRequest": {
"additionalProperties": false,
"required": [
"isDomainUser",
"locale",
"password",
"username"
],
"type": "object",
"properties": {
"connectedFrom": {
"$ref": "Era.Common.DataDefinition.Network.Connection#/definitions/Connection"
},
"isDomainUser": {
"type": "boolean"
},
"locale": {
"type": "string"
},
"loginOneTimeToken": {
"type": "string"
},
"mobilePhoneNumber": {
"type": "string"
},
"otp": {
"type": "string"
},
"password": {
"type": "string"
},
"rememberDevice": {
"type": "boolean"
},
"requestProvisionSms": {
"type": "boolean"
},
"username": {
"type": "string"
}
}
}
}
}