Access and Authentication API

Authentication

POST /kylin/api/user/authentication

Request Header

Authorization data encoded by basic auth is needed in the header, such as: Authorization:Basic {data}
You can generate {data} by using below python script

python -c "import base64; print base64.standard_b64encode('$UserName:$Password')"

Response Body

• userDetails - Defined authorities and status of current user.

Response Sample

{
    "userDetails": {
        "username": "ADMIN",
        "password": "$2a$10$o3ktIWsGYxXNuUWQiYlZXOW5hWcqyNAFQsSSCSEWoC/BRVMAUjL32",
        "authorities": [
            {
                "authority": "ROLE_ADMIN"
            },
            {
                "authority": "ROLE_ANALYST"
            },
            {
                "authority": "ROLE_MODELER"
            },
            {
                "authority": "ALL_USERS"
            }
        ],
        "disabled": false,
        "defaultPassword": false,
        "locked": false,
        "lockedTime": 0,
        "wrongTime": 0,
        "uuid": "29384f19-140a-f651-2f83-c331bcb25400",
        "last_modified": 1594810732763,
        "version": "3.9.9.1"
    }
}

Curl Example

curl -c /path/to/cookiefile.txt -X POST -H "Authorization: Basic XXXXXXXXX" 
-H 'Content-Type: application/json' http://<host>:<port>/kylin/api/user/authentication

If login successfully, the JSESSIONID will be saved into the cookie file; In the subsequent http requests, attach the cookie, for example:

curl -b /path/to/cookiefile.txt -X PUT -H 'Content-Type: application/json' 
-d '{"startTime":'1423526400000', "endTime":'1423612800000', "buildType":"BUILD"}' http://<host>:<port>/kylin/api/cubes/your_cube/build

Alternatively, you can provide the username/password with option “user” in each curl call; please note this has the risk of password leak in shell history:

curl -X PUT --user ADMIN:KYLIN -H "Content-Type: application/json;charset=utf-8" 
-d '{ "startTime": 820454400000, "endTime": 821318400000, "buildType": "BUILD"}' http://localhost:7070/kylin/api/cubes/kylin_sales/build