ProcessMaker API Documentation
Script Central

View Authenticated Clients

View the authenticated clients in your organization.

View All Authenticated Clients

ProcessMaker displays all authenticated clients in one table that ProcessMaker Administrators throughout your organization have created. This makes it easy to manage authenticated clients to allow these ProcessMaker users to access the ProcessMaker's RESTful API. The most recently created authenticated clients display at the top of the table.

Your ProcessMaker user account or group membership must have the "Auth Clients: View Auth Clients" permission to view the list of authenticated clients unless your user account has the Make this user a Super Admin setting selected.

See the Auth Clients permissions or ask your ProcessMaker Administrator for assistance.

Follow these steps to view all authenticated clients:

  1. Log on to ProcessMaker.

  2. Click the Admin option from the top menu. The Users page displays.

  3. Click the Auth Clients icon. The Auth Clients page displays all client authentication keys.

"Auth Clients" page displays all authenticated clients that can access the ProcessMaker's RESTful API

The Auth Clients page displays the following information in tabular format about authenticated clients that can access the ProcessMaker's RESTful API:

  • Client ID: The Client ID column displays the Client ID for the authenticated client. ProcessMaker automatically generates the Client ID value when the client authentication is created and represents a sequential number of how many total authenticated clients have been created to that time.

  • Name: The Name column displays to whom the client authentication applies. See Create a New Client Authentication Key.

  • Redirect: The Redirect column displays the URL that redirects the authenticated client back to the ProcessMaker application. See Create a New Client Authentication Key.

  • Client Secret: The Client Secret column displays the Client Secret for the authenticated client. ProcessMaker automatically generates the Client Secret when the key is created. Click the Copy Client Secret to Clipboard iconto copy the Client Secret. Paste the Client Secret into your ProcessMaker authorization server.

Edit a Client Authentication Key

Click the Edit icon. See Edit a Client Authentication Key.

Create a Client Authentication Key

Click the +Auth Client button. See Create a New Client Authentication Key.

Delete a Client Authentication Key

Click the Delete icon. See Delete a Client Authentication Key.

No Client Authentication Keys?

If no authenticated clients have been created, the following message displays: No Data Available.

Display Information the Way You Want It

Control how tabular information displays, including how to sort columns or how many items display per page.

Related Topics