Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Prerequisites

In order to access the REST APIs, you need to:

  • Create a Requirement Yogi account.

  • Link an Atlassian account to your Requirement Yogi account.

  • Obtain an access token.

Create an account

To create a Requirement Yogi account:

...

Link an Atlassian account

In order to access the REST APIs, you need to To link an Atlassian account to your Requirement Yogi account:

  • Go to https://app.requirementyogi.com.

  • Log in to your Requirement Yogi account.

  • In the top navigation bar, click the profile button.

  • Navigate to Settings.

  • In the left sidebar, navigate to Linked accounts.

  • Click the Link button.

  • You will be redirected to the Atlassian authorization prompt.

  • You will be asked to log in to your Atlassian account if you haven’t already.

  • Choose the Atlassian site for which you want to use our REST APIs.

  • Make sure you agree with the requested permissions.

  • Make sure you’ve read our Privacy Policy and our Terms of Use.

  • Click the Accept button.

  • You can repeat the link process to authorize access to our REST APIs for multiple Atlassian sites.

  • Please note that permissions are checked against the permissions of your linked Atlassian account.

  • Make sure the linked Atlassian account has the appropriate permissions for your use casecases.

Unlink the Atlassian account

If you need to unlink your To unlink the Atlassian account from your Requirement Yogi account:

  • Go to https://app.requirementyogi.com.

  • Log in to your Requirement Yogi account.

  • In the top navigation bar, click the profile button.

  • Navigate to Settings.

  • In the left sidebar, navigate to “Linked accounts”.

  • Click the Unlink button.

  • To completely unlink the Atlassian account, you also need to revoke the app from your connected apps in your Atlassian account settings.

Reset the accessible Atlassian sites

We retrieve the accessible Atlassian sites from the Atlassian REST API.

...

  • Go to https://id.atlassian.com.

  • Log in to your Atlassian account.

  • In the top navigation bar, click the profile button.

  • Navigate to Account settings.

  • In the top navigation bar, navigate to Connected apps.

  • Locate the Requirement Yogi integration app.

  • Click the Remove access button.

Get an access token

...

an access token

...

For now, we use the OAuth 2.0 Password Grant as a temporary authentication strategy while we develop Personal Access Tokens which will improve the security.

...