Skip to end of metadata
Go to start of metadata

Authenticate by Passing Parameters

Do NOT expose clear text password in the URL or DOM.

For JSON API authentication purposes, the following parameters can be posted to each of the JSON API URLs:

  • j_username
  • j_password
  • hash

Example:

Assuming the username and password required is "user1" and "password1" respectively, we can post the username and password to the JSON API using following script.

Sample Call
curl --location --request POST --data 'j_username=user1&j_password=password1' 'http://localhost:8080/jw/web/json/workflow/assignment/list'
Sample Result
{"total" : 12 }

If you prefer to use hashed password, you can use the following script.

Please note that the support on Hashed Password is based on the Directory Manager you are using. Some Directory Manager Plugin may not supporting this type of authentication method.

The format and hashing method may vary for each Directory Manager as well.

Sample Call
curl --location --request POST --data 'j_username=user1&hash=D012B772672A55A0B561EAA53CA7734E' 'http://localhost:8080/jw/web/json/workflow/assignment/list/pending'

Master Login Username and Password

Do NOT expose clear text password in the URL or DOM.

When authentication using parameters, you are allowed to using a Master Credential to login as other user to performance workflow activities. 

To use it, set a Master Login Username and Master Login Password under System Settings > General Setting. By setting these values, a different user can be specified by passing in the "loginAs" parameter.

Please note that only enable this when it is necessary. Leaking of your Master Credential will allows others to performs all the unwanted JSON API calls.

Assuming the master login username and master login password is "master" and "master" respectively, the master login hash will be "E505CF727D214A68CB03DA25DA978500".

The following example showcases how to use a Master Credential to login as "user1".

Sample Call
curl --location --request POST --data 'j_username=master&j_password=master&loginAs=user1' 'http://localhost:8080/jw/web/json/workflow/assignment/list'

Using master login hash:

Sample Call
curl --location --request POST --data 'j_username=master&j_password=master&loginAs=user1' 'http://localhost:8080/jw/web/json/workflow/assignment/list'

Basic Http Authentication

Since V4, Joget Workflow supports Basic HTTP Authentication in JSON API authentication so you can pass the credentials in the header.

Example:
Assuming the username and password required is "user1" and "password1" respectively, we can set the Basic Auth header to the JSON API using following script.

Sample Call
curl --location --request POST 'http://localhost:8080/jw/web/json/workflow/assignment/list/pending' --header 'Authorization: Basic dXNlcjE6cGFzc3dvcmQx'


  • No labels