Login

Product version: 10.11

Last modified: 31 July 2024

Authorizes the user.

Endpoint

https://<Director_IP_address>:4443/c/router

Request Example

Copy 
curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
     --header "content-type: application/json" \
    --cookie-jar cookies.txt \
    --data '{
        "action": "AuthenticationManagement",
        "method": "login",
        "data": ["admin", null, false],
        "type": "rpc",
        "tid": 1}'

Request Fields

Field Type Value(s)
action string 
AuthenticationManagement
method string 
login
data array Username, password, remember_me
type string rpc
tid integer 1

Data

Field Type Description
username string Username for login
password string Password
remember_me boolean If true keeps the user logged in. If false logs the user out within a timeout (10 minutes by default)

Response Sample

Copy 
{
    "action": "AuthenticationManagement",
    "method": "login",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "result": "OK",
        "reason": null,
        "firstTime": false,
        "productConfigured": true,
        "userInfo": {
            "id": 1,
            "name": "admin",
            "isMasterAdmin": true,
            "isAdmin": true,
            "permissions": [
                "ROLE_CONFIG_INVENTORY",
                "ROLE_NOTIFICATION_MANAGE",
                "ROLE_ACTIVITY_VIEW_ACCESS",
                "ROLE_EDIT_JOB",
                "ROLE_EVENT_VIEW",
                "ROLE_ANONYMOUS",
                "ROLE_CREATE_JOB_BACKUP",
                "ROLE_CONFIG_BRANDING",
                "ROLE_CONFIGURATION_VIEW_ACCESS",
                "ROLE_LIST_SAVEPOINTS",
                "ROLE_USER",
                "ROLE_EDIT_GROUP",
                "ROLE_SUPPORT_USE",
                "ROLE_INSTALL_LICENSE",
                "ROLE_CONFIG_CLOUD",
                "ROLE_CONFIG_AUTH",
                "ROLE_BASIC_TRANSPORTER_OPS",
                "ROLE_START_ACTIVITY",
                "ROLE_NOTIFICATION_VIEW",
                "ROLE_JOB_SUMMARY_VIEW",
                "ROLE_MOVE_GROUP",
                "ROLE_CONFIG_BACKUP",
                "ROLE_BASIC_BRANDING_OPS",
                "ROLE_BASIC_BACKUP_OPS",
                "ROLE_STOP_ACTIVITY",
                "ROLE_CREATE_JOB_FLR",
                "ROLE_CREATE_JOB_GROUP_REPORT",
                "ROLE_PRODUCT_UPDATE_CHECK",
                "ROLE_EVENT_MANAGE",
                "ROLE_VIEW_CALENDARS",
                "ROLE_IMAGE_PROCESSING",
                "ROLE_MOVE_JOB",
                "ROLE_BASIC_LICENSING_OPS",
                "ROLE_PRODUCT_MAINTENANCE",
                "ROLE_BASIC_LOGGING_OPS",
                "ROLE_MASTER_ADMIN",
                "ROLE_REMOVE_ACTIVITY",
                "ROLE_STOP_JOB",
                "ROLE_POST_JOB_MESSAGES",
                "ROLE_CONFIG_TRANSPORTER",
                "ROLE_START_JOB",
                "ROLE_BASIC_AUTH_OPS",
                "ROLE_DELETE_GROUP",
                "ROLE_BASIC_INVENTORY_OPS",
                "ROLE_CREATE_JOB_FLASH_VM_BOOT",
                "ROLE_CREATE_JOB_REPLICATION",
                "ROLE_EXPORT_BACKUP",
                "ROLE_CREATE_JOB_VM_RECOVERY",
                "ROLE_VIEW_ACTIVITY",
                "ROLE_CONFIG_INFO",
                "ROLE_CREATE_JOB_OLR",
                "ROLE_CREATE_JOB_VIRTUAL_MOUNT",
                "ROLE_QUERY_JOB",
                "ROLE_CONFIG_EVENTS",
                "ROLE_SEARCH_JOB",
                "ROLE_ENABLE_DISABLE_JOB",
                "ROLE_CREATE_JOB_BACKUP_COPY",
                "ROLE_CONFIG_REPORTING",
                "ROLE_CONFIG_LICENSING",
                "ROLE_LOAD_JOB",
                "ROLE_DELETE_JOB",
                "ROLE_ADMIN",
                "ROLE_CONFIG_MT",
                "ROLE_CREATE_GROUP"],
            "tid": "0",
            "email": null,
            "firstLoginRelative": -3666638171},
        "canTry": {
            "isPossible": true,
            "waitTimeLeft": 0,
            "failedAttempts": 0}}
}

Response Fields

Field Value Description
message string Message if the request failed
where string Reference to the method where the problem occurred
cause string Cause of failure
result string Result of the request
reason string If the request failed, the reason for the failure
firstTime boolean Checks if the user logs in for the first time
productConfigured boolean Checks if the product properly configured
id int User ID
name string Username
isMasterAdmin boolean Checks if the user has master admin privileges
isAdmin boolean Checks if the user has admin privileges
permissions array The list of user's permissions
tid int Transaction ID
email string User's email (null if not stated)
firstLoginRelative int Time since the first login (in seconds)
canTry JSON Checks if the user can log in. The user can be blocked after unsuccessful attempts.
isPossible boolean If true the user can log in
waitTimeLeft int If the user is blocked, returns the time left till the next retry can be made
failedAttempts int The number of failed attempts