Last updated Apr 7, 2023

Rate this page:

Authentication

There are a few types of authentication that can be used when makeing requests to PAPI through AGG:

Partner Authorization

Once a user is authenticated on AGG, PAPI goes through even more validation to ensure the user/org is linked to an active partner account, and that their status is in good standing. Only active partners can access PAPI and the scope of data is restricted to the verified domain(s) of an organization or to a particular user, depending on the authentication type.

Auth TypeUsageScope
Org API Key
  • AGG GraphQL API
  • AGG Playgound UI
Data is restricted to a particular organization which
can have multiple verified domains
User API Token
  • AGG Playgound UI
Data is restricted to a particular user

Org API Key

Org API keys are constrained to a specific organization. Organizations can have multiple verified domains, in which case the scope of the Org API key would inherit permissions only to these domain(s). Org API keys authenticate an org (App account). If you already have an API key, you can use it for authenticating to PAPI. Org API keys are intended for implementation but can also be used for testing in the AGG Playground.

More info on how to create an Org API key

User API Token

User API tokens are not constrained to a specific resource or resource type, and they have the same permissions as the user that created them. User API tokens authenticate as a user (Atlassian account). If you already have an API token, you can use it for authenticating to PAPI. API tokens are only permitted when testing in the AGG Playground.

More info on how to create a User API token

OAuth

Work in progress...

Rate this page: