Skip to main content

OAuth 2.0 for REST API

Configure Alteryx Analytics Cloud (AAC) to integrate with your REST API deployment using OAuth 2.0 authentication.

Note

The end system on this page refers to the application to which the REST API Connections establish a connection.

Create OAuth 2.0 Client App in the End System

In the end system developer console, you must create a client app. Follow these steps...

  1. Sign in to your end system developer console.

  2. Create a new application that uses OAuth 2.0 for authentication.

  3. Record your Client ID and Client Secret. You will use these for the REST API OAuth 2.0 setup in AAC.

  4. Enter your Redirect URIs. For example, https:/app.endsystem.com.

  5. Make sure you provide the correct scopes.

Create OAuth 2.0 Client for REST API in AAC

After you create the end system client app, you must create an OAuth 2.0 client in AAC. Follow these steps...

  1. Sign in to AAC as a Workspace Admin.

  2. Go to Profile menu > Workspace Admin > OAuth 2.0 clients > Register OAuth 2.0 client.

  3. Enter these fields:

    Field

    Action

    Authentication Type

    Select REST API OAuth 2.0 - Auth Code Grant from the dropdown.

    Name

    Enter an appropriate name for the client.

    Client ID

    Enter the Client ID you recorded from the end system client app setup.

    Client Secret

    Enter the Client Secret you recorded from the end system client app setup.

    Authorization URL

    Paste the Authorization URL of the end system. For example:

    https://account.endsystem.com/api/oauth2/authorize

    Token URL

    Paste the Token URL of the end system. For example:

    https://api.endsystem.com/oauth2/token

    Scopes

    Enter the scope definition. This depends on the scope names configured in your end system.

    Access Token Expires In

    Enter 3600000 ms.

    Refresh Token Expires In

    Enter 0 ms.

  4. Select Create.

Create REST API Connection

After you create the OAuth 2.0 client references, you can create a connection to your end system data. For more information, go to REST API Connections.

Note

You must create a separate connection for each OAuth 2.0 client that is available in the AAC.

In this section: