icon-zws.svg
Workflow Automation

Managing Workflow Automation API Keys

If you have a subscription to Workflow Automation, API Management is automatically accessible to an admin role. An admin can create and display the API key required for authenticating with the Workflow Automation API to make API calls.

The API Keys page allows you to perform the following actions:

  • The Create API Key action allows you to create API keys for an admin. An API key must be created for authentication to make API calls.

    To create a new API key:

    1. Go to Setup > API Management. The API Keys page appears, listing the API keys.
    2. Click Add More. The Create API Key window appears.
    3. In the Create API Key window:
    • Name: Enter the name for the API key.
    • Expiration Time: (Optional) Enable to set an expiration time for the API key.
      • Lifetime (days): Enter the number of days that you want the key to be valid.

    If the Expiration Time option is disabled, the API key has no expiration time.

    1. Click Submit. The API Key window appears.
    2. In the API Key window, click the Copy icon to copy the Key Secret and the Key ID. You need both for authentication.

    The key secret is only available to copy when creating an API key. Copy and save the key secret for authentication.

    1. Click Done to close the window.
    Close

  • When created, the API key is enabled by default. You can use the toggle button corresponding to a specific API key to disable that key.

    To disable an API key:

    1. Go to Setup > API Management. The API Keys page appears, listing the API keys.
    2. On the API Keys page, click the blue toggle under the Action column to disable a specific API key.

    The API key is disabled and cannot be used for authentication. You can use the same action to enable the API key when needed.

    Close

  • You can generate a new key secret for the same admin and the key ID.

    To regenerate an API key:

    1. Go to Setup > API Management. The API Keys page appears, listing the API keys.
    2. On the API Keys page, click the Regenerate icon corresponding to a specific API key.
    3. Click Yes in the pop-up window that appears.

    A new key secret for the API key is generated.

    Close

  • The Delete action allows you to delete the specified API key.

    To delete an API key:

    1. Go to Setup > API Management. The API Keys page appears, listing the API keys.
    2. On the API Keys page, click the Delete icon for a specific API key.
    3. Click Yes in the pop-up window that appears.

    The API key is deleted permanently.

    Close

To learn more, see About API Keys.

Related Articles
About API KeysManaging Workflow Automation API Keys