You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Definition

Group API can perform functions to interact or exchange data for Joget Users.


NameDescription
1

Add user

Add a new user account.

Name

Description
URL/user
HTTP MethodPOST
Body Parameters
ParameterDescription
idUser ID of user.
usernameUsername of user.
firstNameUser's first name.
lastNameUser's last name.
emailUser's email.
activeUser's account active status.
timeZoneUser's time zone.
localeUser's locale.
Sample Response
{
  "id": "apiUser",
  "username": "apiUser",
  "firstName": "API",
  "lastName": "User",
  "email": "",
  "active": 1,
  "timeZone": "",
  "locale": ""
}
2

Delete user

Delete a user account.

Name

Description
URL/user/{username}
HTTP MethodDELETE
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
{
  "date": "Fri Aug 30 00:38:43 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
3

Find HOD by username

Find the HOD of the department that the specified user belongs to, via username.
4

Find subordinate by username

Find all users that report to the specified user, via username.
5

Find user

Get user details of all users by default.

Able to filter or sort the returned results via parameters.

6

Get Department HOD

Get user details of the HOD of the department, via department ID.
7

Get employment info

Get employment details of a user via username.
8

Get roles by username

Get the roles (e.g: regular user or Joget administrator) of a user via username.
9

Get user by username

Get user details of a user via username.
10

Update user

Update the user details of a user.




  • No labels