View Source

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

Marketplace Knowledge Base > User > image2019-8-20_17-6-2.png

Name

Description

1

Add user

Add a new user account.

Name

Description

URL

/user

HTTP Method

POST

Body Parameters

Parameter	Description
id	User ID of user.
username	Username of user.
firstName	User's first name.
lastName	User's last name.
email	User's email.
active	User's account active status.
timeZone	User's time zone.
locale	User'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 Method

DELETE

Path Parameters

Parameter	Description
username	Username 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 Method

GET

Path Parameters

Parameter	Description
username	Username 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 Method

GET

Path Parameters

Parameter	Description
username	Username 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 Method

GET

Query String Parameters

Parameter	Description
nameFilter	Filters the response via user ID.
organizationId	Filter users that belong to an organization, via organization ID.
departmentId
gradeId
groupId
roleId
active
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.
startOffset	Starting position of records to start query. Expects an integer.
pageSize	Number 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