Service Apps and tokens

  Administrator or Developer role required. For information about user roles, see User roles.

The Apps and tokens page lists tokens for accessing the Nintex platform API. Apps can request tokens that are used for API requests to access all tasks, instances and workflows in your Nintex CE Platform tenant. You can use personal access tokens to make API requests to access what you have permissions for in your Nintex CE Platform tenant.

You can perform the following actions in this page:

  • Add, view, disable, activate, and delete apps.
  • Add, view, revoke, and delete personal access tokens.

Access the Apps and tokens page

  • Go to Settings > Environment > Apps and tokens

Manage apps

  1. Go to Settings > Environment > Apps and tokens

  2. Click Add app.

  3. In the Add app section, type an App name and a Description.

  4. Click Add.

    The new app is added with Active status and a green checkmark briefly appears in the newly added app.

  1. Go to Settings > Environment > Apps and tokens

  2. In the Apps section, click and then select View for the required app.

    3. The Client ID and Client Secret are displayed for the selected app.

Note: Any API calls using that app's credentials will fail once the app is disabled.

  1. Go to Settings > Environment > Apps and tokens

  2. In the Apps section, click and then select Disable for the required app.

    The app's Status is updated to Disabled.

  1. Go to Settings > Environment > Apps and tokens

  2. In the Apps section, click and then select Activate for the required app.

    3. The app's Status is updated to Active.

Note: Any API calls using that app's credentials will fail once the app is deleted.

  1. Go to Settings > Environment > Apps and tokens

  2. In the Apps section, click and then select Delete for the required app.

    3. The deleted app is removed from the Apps section.

Manage personal access tokens

Tokens automatically expire 12 months from the date of creation.

  1. Go to Settings > Environment > Apps and tokens

  2. In the personal access tokens section, click Add token.

  3. In the Create new token section, type a Name.

  4. Click Create.

    The new token is added to the personal access tokens section and a green checkmark briefly appears to the left of the token. The expiration date is 12 months from the date of creation.

  1. Go to Settings > Environment > Apps and tokens

  2. In the Personal access tokens section, click and then select View for the required token.

    3. The selected personal access token identifier is displayed.

Revoke a token if you want to deny access to your Nintex CE Platform tenant with that token.

Note: Revoke tokens with care. API requests using revoked tokens will fail.

  1. Go to Settings > Environment > Apps and tokens

  2. In the Personal access tokens section, click and then select Revoke for the required token.

  3. Click Yes to confirm.

    The status of the selected token is updated to Revoked.

Delete a token to remove it from your Nintex CE Platform tenant. You can only delete a token if it has expired or been revoked.

  1. Go to Settings > Environment > Apps and tokens

  2. In the Personal access tokens section, click and then select Delete for the required token.

  3. Click Yes to confirm.

    The deleted token is removed from the personal access tokens section.

Section Selection (or column or field) Description
Apps Add app

Displays the Add app section with the following fields and buttons:

  • App name: Identifiable name for the app.
  • Description: Brief note describing the purpose of the app.
  • Add: Saves the changes.
  • Cancel: Aborts the changes.
  Created by The name of the user who added the app.
  Status

Displays the following app statuses:

  • Active
  • Disabled
  (Options)

Lists the following selections.

  • View: Displays app token identifier for use.
  • Disable: Disables token, invalidating its use in any API requests.
  • Delete: Deletes the selected token.
Personal access tokens

Create new

Displays the Create new token section with the following fields.

  • Name: User-friendly descriptor for new token.

  • Expires: Expiration date. Read-only.

Click Create to save your changes.

 

Status

Displays the following token statuses:

  • Active
  • Revoked
  • Expired
 

Created by

User name of the person who created the token.
 

Expires

Expiration date of the token.
 

(Options)

Lists the following selections.

  • View: Displays token identifier for use.
  • Revoke: Revokes token, invalidating its use in any API requests.
  • Delete: Deletes token, removing traceability. This option is available for revoked tokens.