Alteryx Server Knowledge Base

Definitive answers from Server experts.

How to: Configure users for API calls in 2022.1

blakecasey
Alteryx Alumni (Retired)
Created

How to: Configure users for API calls in 2022.1

Starting in 2022.1, there is only support for API using Oauth 2. There are some Gallery specific requirements to call the endpoints.
 

Prerequisites

  • Alteryx Server
    • 2022.1
    • API enabled for the user
  • API Key/secrets
  • OAuth 2.0
 

Procedure for /v1 and /v2 endpoints

  1. These endpoints will require the user making the call to be at least the Artisan role.
  2. The user will need to belong to the studio or workspace of the asset being called.
  3. Use the API key and secret listed as "API Access Key" and "API Access Secret" found in My Profile. (The Private Studio keys/secret combo will result in errors). See image below in the /v3 endpoint section.

Procedure for /v3 endpoints

  1. These endpoints will require the user making the call to be the Curator role.
  2. Use the API key and secret listed as "API Access Key" and "API Access Secret" found in My Profile. (The Private Studio keys/secret combo will result in errors). See image below.
image.pngimage.png
***If these API key and secrets are not visible, it may need to be enabled for the specific user. This option is available to Curators and Server Admins.

Users may encounter the below error if these conditions are not met when making the call.
Authorization has been denied for this request

 


 

Additional Resources