Inicio de sesión

Versión del producto: 10.11

Último modificado: 31 julio 2024

Autoriza al usuario.

Punto final

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

Ejemplo de solicitud

Copiar 
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}'

Campos de solicitud

Campo Tipo Valor(es)
action string 
Gestión de autenticación
method string 
inicio de sesión
data array Nombre de usuario, contraseña, remember_me
type string rpc
tid integer 1

Datos

Campo Tipo Descripción
username string Nombre de usuario para iniciar sesión
password string Contraseña
remember_me boolean Si true mantiene al usuario conectado. Si false cierra la sesión del usuario dentro de un tiempo de espera (10 minutos por defecto).

Muestra de respuesta

Copiar 
{
    "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}}
}

Campos de respuesta

Campo Valor Descripción
message string Mensaje si la solicitud ha fallado
where string Referencia al método en el que se produjo el problema
cause string Causa del fallo
result string Resultado de la solicitud
reason string Si la solicitud ha fallado, el motivo del fallo
firstTime boolean Comprueba si el usuario se conecta por primera vez.
productConfigured boolean Comprueba si el producto está correctamente configurado
id int ID de usuario
name string Nombre de usuario
isMasterAdmin boolean Comprueba si el usuario tiene privilegios de administrador maestro
isAdmin boolean Comprueba si el usuario tiene privilegios de administrador
permissions array La lista de permisos del usuario
tid int ID de transacción
email string Correo electrónico del usuario (null si no se indica)
firstLoginRelative int Hora desde el primer inicio de sesión (en segundos)
canTry JSON Comprueba si el usuario puede iniciar sesión. El usuario puede ser bloqueado después de intentos fallidos.
isPossible boolean Si true el usuario puede conectarse
waitTimeLeft int Si el usuario está bloqueado, devuelve el tiempo que queda hasta que se pueda realizar el siguiente reintento
failedAttempts int Número de intentos fallidos