ÃÛ¶¹ÊÓƵ

DocumentationWorkfrontWorkfront Guide

ÃÛ¶¹ÊÓƵ Authenticator modules

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

The ÃÛ¶¹ÊÓƵ Authenticator module allows you to connect to any ÃÛ¶¹ÊÓƵ API, using a single connection. This allows you to more easily connect to ÃÛ¶¹ÊÓƵ products that do not yet have a dedicated Fusion connector.

The advantage over the HTTP modules is that you can create a connection, as in a dedicated app.

To see a list of available ÃÛ¶¹ÊÓƵ APIs, see . You may be able to use only the APIs to which you are assigned.

Access requirements

ÃÛ¶¹ÊÓƵ Workfront plan

New: Any

Or

Current: Pro or higher

ÃÛ¶¹ÊÓƵ Workfront license

New: Standard

Or

Current: Plan, Work

ÃÛ¶¹ÊÓƵ Workfront Fusion license

Current Fusion license requirement: No Workfront Fusion license requirement.

Or

Legacy Fusion license requirement: Workfront Fusion for Work Automation and Integration

Product

New Workfront plan: If you have the Select or Prime ÃÛ¶¹ÊÓƵ Workfront Plan, your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan.

Or

Current Workfront plan: Your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ Workfront to use functionality described in this article.

Prerequisites

  • You must have access to the ÃÛ¶¹ÊÓƵ product that you want the module to connect to.

  • You must have access to the ÃÛ¶¹ÊÓƵ Developer Console.

  • You must have a project on the ÃÛ¶¹ÊÓƵ Developer Console that includes the API that you want the module to connect to. You can:

    • Create a new project with the API.

      Or

    • Add the API to an existing project.

    For information on creating or adding an API to a project on the ÃÛ¶¹ÊÓƵ Developer Console, see in the ÃÛ¶¹ÊÓƵ documentation.

ÃÛ¶¹ÊÓƵ Authenticator API information

The ÃÛ¶¹ÊÓƵ Authenticator connector uses the following:

API tag
v1.1.4

Create a connection

An ÃÛ¶¹ÊÓƵ Authenticator connection connects to a single project on the ÃÛ¶¹ÊÓƵ Developer Console. To use the same connection for more than one ÃÛ¶¹ÊÓƵ API, add the APIs to the same project, and create a connection to that project.

You can create separate connections to separate projects, but you cannot use a connection to access an API that is not on the project specified in that connection.

IMPORTANT
With the ÃÛ¶¹ÊÓƵ Authenticator connector, you have the choice between making an OAuth Server-to-server connection, or a Service Account (JWT) connection. ÃÛ¶¹ÊÓƵ has deprecated JWT credentials, which will stop working after January 1, 2025. Therefore, we highly recommend creating OAuth connections.
For more information on these types of connections, see in the ÃÛ¶¹ÊÓƵ documentation

To create a connection:

  1. In any ÃÛ¶¹ÊÓƵ Authenticator module, click Add next to the Connection field.

  2. Fill in the following fields:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 layout-auto html-authored no-header
    Connection type Select whether you want to create an OAuth Server-to-Server connection, or a service account (JWT) connection.
    Connection name Enter a name for this connection.
    Client ID Enter your ÃÛ¶¹ÊÓƵ Client ID. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console.
    Client Secret Enter your ÃÛ¶¹ÊÓƵ Client Secret. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console.
    Scopes If you have selected an OAuth connection, enter the scopes needed for this connection.
    Technical account ID Enter your ÃÛ¶¹ÊÓƵ Technical account ID. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console.
    Organization ID If you have selected a JWT connection, enter your ÃÛ¶¹ÊÓƵ Organization ID. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console.
    Meta Scopes If you have selected a JWT connection, enter the meta scopes needed for this connection.
    Private key

    If you have selected a JWT connection, enter the private key that was generated when your credentials were created in the ÃÛ¶¹ÊÓƵ Developer Console.

    To extract your private key or certificate:

    1. Click Extract.

    2. Select the type of file you are extracting.

    3. Select the file that contains the private key or certificate.

    4. Enter the password for the file.

    5. Click Save to extract the file and return to the connection setup.
    Base URLs

    You must add the base URLs that you want this authenticator to allow. When using the Make a custom API call module later in the scenario, you will add a relative path to the chosen URL. By entering URLs here, you can control what the Make a custom API call module can connect to, which increases security.

    For each base URL that you want to add to the authenticator, click Add item and enter the base URL.
    Authentication URL Leave this blank to use the standard ÃÛ¶¹ÊÓƵ IMS authentication URL of https://ims-na1.adobelogin.com. If you do not use ÃÛ¶¹ÊÓƵ IMS for authentication, enter the URL to use for authentication.
    Environment Select whether you are connecting to a production or non-production environment.
    Type Select whether you are connecting to a service account or a personal account.

  3. Click Continue to save the connection and return to the module.

Modules

Make a custom API call

This action module allows you to make a call to any ÃÛ¶¹ÊÓƵ API. It supports large files, instead of text-only bodies.

This module was made available on November 14, 2024. Any ÃÛ¶¹ÊÓƵ Authenticator > Make a custom API call configured before this date does not handle large files, and is now considered the Make a custom API call (Legacy) module.

Connection
For instructions on creating a connection to the ÃÛ¶¹ÊÓƵ Authenticator module, see Create a connection in this article.
Base URL
Enter the base URL of the API point you want to connect to.
URL
Enter the path relative to the base URL.
Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in ÃÛ¶¹ÊÓƵ Workfront Fusion.
Headers

Add the headers of the request in the form of a standard JSON object.

For example, {"Content-type":"application/json"}

Workfront Fusion adds authorization headers automatically.

Query String
Enter the request query string.
Body Type

Select the body type for this API request:

  • application/x-www-form-urlencoded
  • Raw
  • multipart/form-data
Fields
For each file that you want to add to the APU request, click Add item and enter the text of the file (for raw data), or enter the key uploadedFile and map the file's data.

Make a custom API call (Legacy)

This action module allows you to make a call to any ÃÛ¶¹ÊÓƵ API.

Connection
For instructions on creating a connection to the ÃÛ¶¹ÊÓƵ Authenticator module, see Create a connection in this article.
Base URL
Enter the base URL of the API point you want to connect to.
URL
Enter the path relative to the base URL.
Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in ÃÛ¶¹ÊÓƵ Workfront Fusion.
Headers

Add the headers of the request in the form of a standard JSON object.

For example, {"Content-type":"application/json"}

Workfront Fusion adds authorization headers automatically.

Query String
Enter the request query string.
Body

Add the body content for the API call in the form of a standard JSON object.

Note:

When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

Limit
Enter the maximum number of results that you want the module to return in one execution cycle.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43