Skip to main content

Module: admin

Method

Parameters

HTTP Method

Description

URL Example

addUser

String username, String password, String role

POST

Adds a new user to AIQ properties, allows only POST request

http://localhost:8080/AppvanceServer/rest/admin/addUser?username=username&password=password&role=role

changeMyStatus

String status


Changes status for the current user


changePassword

String password

POST

Used to change the password of the logged in user.

http://localhost:8080/AppvanceServer/rest/admin/changePassword?password=password

changePasswordAsAdmin

String username, String password


Changes password for the username as admin account


deleteUser

String username

POST

Deletes the mentioned user from the AIQ system.

http://localhost:8080/AppvanceServer/rest/admin/deleteUser?username=userName

deleteUserAsAdmin

String username


Deletes the current user session from realm.properties


getActiveSessions



Returns jsonArray with active sessions (username and lastTimeAccessed timestamp)

http://localhost:8080/AppvanceServer/rest/admin/getActiveSessions

getAuthKey



Generates an authentication key for the current user session

http://localhost:8080/AppvanceServer/rest/admin/getAuthKey

getLogInHistory


GET / POST

Gets the last logins

http://localhost:8080/AppvanceServer/rest/admin/getLogInHistory

getPagesRange

String username


gets the activity logs ranges

http://localhost:8080/AppvanceServer/rest/admin/getPagesRange

getRemoteAddress


GET/ POST

Return the incoming request remote IP address

http://localhost:8080/AppvanceServer/rest/admin/getRemoteAddress

getUserLogs

String username


gets the user logs

http://localhost:8080/AppvanceServer/rest/admin/getUserLogs

getUserLogsByRange

String username, String range


get the activity logs by range and user name

http://localhost:8080/AppvanceServer/rest/admin/getUserLogsByRange?username=appvance&range=1to87

getUsername


GET/ POST

Return the username

http://localhost:8080/AppvanceServer/rest/admin/getUsername

getUserRole


GET/ POST

Return the role of the user.

http://localhost:8080/AppvanceServer/rest/admin/getUserRole

isAdmin


GET/ POST

Return true is the current user session is an administrative user

http://localhost:8080/AppvanceServer/rest/admin/isAdmin

isAdminOrOwner


GET/ POST

Return true is the current user session is either Admin or owner ruser

http://localhost:8080/AppvanceServer/rest/admin/isAdminOrOwner

isLogged


GET/ POST

Checks whether the user is logged

http://localhost:8080/AppvanceServer/rest/admin/isLogged

isOwner


GET/ POST

Return true is the current user session is an owner user

http://localhost:8080/AppvanceServer/rest/admin/isOwner

isSaas


GET/ POST

Return true is the current user session is an saas user

http://localhost:8080/AppvanceServer/rest/admin/isSaas

listUsers


GET/ POST

Lists all of the registered users

http://localhost:8080/AppvanceServer/rest/admin/listUsers

listUsersByType

String type

GET/ POST

Lists the users macthing the given type, type value can be \"admin\" or \"user\"

http://localhost:8080/AppvanceServer/rest/admin/listUsersByType?type=type

loggin

String username, String password

POST

Logs In a user with password based credentials, allows only POST requests

http://localhost:8080/AppvanceServer/rest/admin/loggin?username=appvance&password=appvance

logginForServices

String username, String password

POST

Logs In a user with password based credentials, allows only POST requests


logginWithCloseSession

String username, String password, Boolean Anglicization

POST

Logs In a user with password based credentials, allows only POST requests


logInWithAuthKey

String key


Logs In a user with authentication key based crendentials.

http://localhost:8080/AppvanceServer/rest/admin/logInWithAuthKey?key=334598.1410969613

logInWithToken

String token


Logs In a user with token based credential


logout


GET/ POST

Logs Out the current user session

http://localhost:8080/AppvanceServer/rest/admin/logout

resetPassword

String username


Reset the user password to the default by the given user name. Allows only POST request


updateUser

String username, String role

POST

Updates the user identified by the given user name with the given user role. Allows only POST request

http://localhost:8080/AppvanceServer/rest/admin/updateUser?username=appvance&role=admin

updateUser

String username, String role

POST

Updates the user identified by the given user name with the given user role. Allows only POST request


uploadFile

String username, String fileName

POST

Allows to upload file to home repo, allows only POST requests

http://localhost:8080/AppvanceServer/rest/file/uploadFiletoLocalRepository?username=username&dir=fileName