Client apps

  A global administrator role is required. For information, see User roles.

Create and manage external client applications that can access only the Nintex Automation Cloud data for users who consent and thereby prevent unauthorized access to other users' data. Client apps must be created under your personal account or organization account where you have administrative rights. After they are created, the client apps will grant API access to Nintex Automation Cloud using OAuth authorization flows.

For more information on OAuth client apps, see the API guide.

Note: The maximum number of client apps that can be created in a tenant is 10.

Benefits of creating client apps include:

• Increased security and the ability to audit client applications.

• Improved third party client app experience. Client apps recognize the user as the current user.

• Reduced effort implementing security when developing custom applications for customers. You do not need to filter data based on user context to implement security by obscurity.

• Improved integration between business applications increases efficiency.

Access the Client Apps page

1. On the top navigation bar, click Settings.

2. On the left menu, click Client apps.

   You can view previously created client apps, including their names, descriptions, client IDs, and the date and time they were created.

Add client apps

1. On the top navigation bar, click Settings.

2. On the left menu, click Client apps.

3. Click Add client app.
4. Enter the App name. The name cannot be more than 200 characters.
5. Enter a Description for the client app. The description cannot be more than 1000 characters.
6. Enter the Redirect URL. This URL must begin with http:// or https:// and cannot be more than 400 characters. If you are using a local development environment, you can use https://localhost.
7. Select Scopes (permissions) for which you want to grant access to the token. For example, you may only want to grant read access to specific resources like records, instances, and tables. You can request a subset of these scopes when requesting access tokens, but cannot request any scopes that are not enabled for the client app.
8. Click Save at the top of the page.

   A client secret is generated. If desired, click the Copy icons to copy the client ID and client secret to your clipboard for use in your client applications.

   Important: Make sure to securely store your client secret as it will not be visible after you close the dialog.

Edit client apps

1. On the top navigation bar, click Settings.

2. On the left menu, click Client apps.

3. Click on the App Name or click on the right of the client app you want to edit and select Edit.
4. Edit the client app details and click Save at the top of the page.

Delete client apps

After you delete a client app, applications using it will no longer be able to access the Nintex Automation Cloud API. You cannot undo deletions.

1. On the top navigation bar, click Settings.

2. On the left menu, click Client apps.

3. Click on the App Name and then click Delete at the top of the page, or click on the right of the client app you want to delete and select Delete.
4. Ensure that you want to delete the client app and then click Delete.

Regenerate client secret

Regenerating the client secret deletes the old secret. Applications using the old client secret will no longer be able to access the Nintex Automation Cloud API until they are updated with the new client secret.

1. On the top navigation bar, click Settings.

2. On the left menu, click Client apps.

3. Click on the App Name.
4. Click Regenerate client secret at the top of the page.
5. Ensure that you want to regenerate the client secret and then click Regenerate.

   The client secret is regenerated. If desired, click the Copy icons to copy the client ID and client secret to your clipboard for use in your client applications.

   Important: Make sure to securely store your client secret as it will not be visible after you close the dialog.