Skip to main content
Version: v20 R4

$directory

The directory handles user access through REST requests.

$directory/login

Opens a REST session on your 4D application and logs in the user.

Description

Use $directory/login to open a session in your 4D application through REST and login a user. You can also modify the default 4D session timeout.

All parameters must be passed in headers of a POST method:

Header keyHeader value
username-4DUser - Not mandatory
password-4DPassword in plain text - Not mandatory
session-4D-lengthSession inactivity timeout (minutes). Cannot be less than 60 - Not mandatory
caution

Since the password is transmitted in plain text, it is strongly recommended to use a secured https connection for the login request.

Example

C_TEXT($response;$body_t)
ARRAY TEXT($hKey;3)
ARRAY TEXT($hValues;3)
$hKey{1}:="username-4D"
$hKey{2}:="password-4D"
$hKey{3}:="session-4D-length"
$hValues{1}:="john"
$hValues{2}:="123"
$hValues{3}:=120
$httpStatus:=HTTP Request(HTTP POST method;"app.example.com:9000/rest/$directory/login";$body_t;$response;$hKey;$hValues)

Result:

If the login was successful, the result will be:

{
"result": true
}

Otherwise, the response will be:

{
"result": false
}