About this Page
This setting is where you securely store your Atlassian Admin API credentials within the Revyz app. An Atlassian Admin API key is an organization-level credential used to securely authenticate Revyz with Atlassian Administration REST APIs.
What is the Use Case?
-
To securely authenticate our application with your Atlassian Organization, allowing Revyz app to interact with organization-wide data rather than just individual Jira sites.
-
Enables Revyz app to provide customers with powerful cross-site analytics, track and manage Marketplace app licenses, and deeply audit user access and permissions across your entire organization.
Why is Atlassian API token needed?
The Atlassian API token only gives Revyz access to a single Jira site. The Admin API key works at a higher level, it connects Revyz to your entire Atlassian Organization.
This lets Revyz:
-
Provide analytics and reporting across all your Jira sites, not just one
-
Track and manage Marketplace app licenses for your organization
-
Audit user access and permissions across your whole organization
Without this key, Revyz can only see one site at a time and won't be able to show organization-wide analytics, license tracking, or access audits.
Configuring the token for backup
How to get your Atlassian Admin API Key?
-
Log in to admin.atlassian.com as an Organization Admin.
-
Select your organization and go to Settings > API keys.
-
Click Create API key.
-
Choose API keys without scopes so Revyz gets the visibility it needs.
-
Copy your new API Secret Key and Organization ID.
Tip: You can also find your Organization ID in your browser address bar right after
/o/(for example:[admin.atlassian.com/o/YOUR-ORG-ID](https://admin.atlassian.com/o/YOUR-ORG-ID)).
How to enter the key in Revyz app
-
In Revyz, go to Settings > Backup settings > Atlassian Admin API Key.
-
Click the Edit button in the top right corner.
-
Paste your Organization ID and API Secret Key.
-
Pick the Expiry Date that matches when your key expires.
-
Click Save.