Definition

User API can interact with Users in the Joget built-in directory manager.


NameDescription
1

Add user

Add a new user account.

Name

Description
URL/user
HTTP MethodPOST
Body Parameters
ParameterDescription
idUser ID of user.
username

Username of user.

passwordUser's password.
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.

Name

Description
URL/user/findHod/{username}
HTTP MethodGET
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
[
  {
    "id": "clark",
    "username": "clark",
    "firstName": "Clark",
    "lastName": "Kent",
    "email": "",
    "active": 1,
    "timeZone": "",
    "locale": null
  }
]
4

Find subordinate by username

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

Name

Description
URL/user/findSubordinate/{username}
HTTP MethodGET
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
[
  {
    "id": "clark",
    "username": "clark",
    "firstName": "Clark",
    "lastName": "Kent",
    "email": "",
    "active": 1,
    "timeZone": "",
    "locale": null
  },
	.....
]
5

Find user

Get user details of all users by default.

Able to filter or sort the returned results via parameters.

Name

Description
URL/user/find
HTTP MethodGET
Query String Parameters
ParameterDescription
nameFilterFilters the response via user ID.
organizationIdFilter users that belong to an organization, via organization ID.
departmentIdFilter users that belong to a department, via department ID.
gradeIdFilter users that belong to a grade, via grade ID.
groupIdFilter users that belong to a group, via group ID.
roleIdFilter users that has such role (e.g: role_user OR role_admin).
active

Filter users by account active status.

1 for active, 0 for inactive.

sort

User data column to sort.

Must be used in conjunction with "sortDescending" parameter.

sortDescending

Sort the specified "sort" parameter value in ascending or descending order.

Expects a boolean value.

Must be used in conjunction with "sort" parameter.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
[
  {
    "id": "admin",
    "username": "admin",
    "firstName": "Admin",
    "lastName": "Admin",
    "email": null,
    "active": 1,
    "timeZone": "0",
    "locale": null
  },
	.....
]
6

Get Department HOD

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

Name

Description
URL/user/findHodByDepartment/{departmentId}
HTTP MethodGET
Path Parameters
ParameterDescription
departmentIdDepartment ID.
Sample Response
{
  "id": "terry",
  "username": "terry",
  "firstName": "Terry",
  "lastName": "Berg",
  "email": "",
  "active": 1,
  "timeZone": "",
  "locale": null
}
7

Get employment info

Get employment details of a user via username.

Name

Description
URL/user/employment/{username}
HTTP MethodGET
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
{
  "startDate": "Apr 1, 2019",
  "endDate": "Aug 29, 2019",
  "employeeCode": "JOGET-0098-D",
  "gradeId": "G-003",
  "departmentId": "D-005",
  "organizationId": "ORG-001"
}
8

Get roles by username

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

Name

Description
URL/user/roles/{username}
HTTP MethodGET
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
[
  {
    "id": "ROLE_ADMIN",
    "name": "Admin",
    "description": "Administrator"
  },
  {
    "id": "ROLE_SYSADMIN",
    "name": "ROLE_SYSADMIN",
    "description": null
  }
]
9

Get user by username

Get user details of a user via username.

Name

Description
URL/user/{username}
HTTP MethodGET
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
{
  "id": "cat",
  "username": "cat",
  "firstName": "Cat",
  "lastName": "Grant",
  "email": "",
  "active": 1,
  "timeZone": "8",
  "locale": null
}
10

Update user

Update the user details of a user.

Name

Description
URL/user
HTTP MethodPUT
Body Parameters
The user ID specified must be of an existing user, to update its details successfully.
ParameterDescription
idUser ID of user.
usernameUsername of user.
passwordUser's password.
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 Pro",
  "email": "apiUserPro@email.com",
  "active": 1,
  "timeZone": "8",
  "locale": ""
}




  • No labels