Credentials

This page is about Easy Integrations for Jira Cloud. Using Jira On-Prem? Click the On-Prem button above.

This documentation guides you through the process of defining and managing credentials in Easy Integrations for Jira Cloud. A general rule of thumb is to define credentials globally within the app scope to enhance reusability. By doing so, you won't need to change all usernames/passwords that are used in post functions when the credential changes. You can define as many credentials as you want.

How-to

To define credentials for Easy Integrations, follow these steps:

  1. Navigate to Apps in the Jira top menu and select Manage your apps.

  2. From the sidebar, navigate to Easy Integrations configuration.

  3. Click on the Credentials app menu item.

  4. Click Create. The Create Credential pop-up will appear.

  5. Give your credential a name.

  6. Toggle the switch to make the credential private if needed. This restricts access and modification to other administrators.

  7. Choose the appropriate authorization type:

    • Basic:

      • Explanation: Basic authorization involves sending a username and password with each request to authenticate the user or system.

      • Usage: This method is often used for simple authentication where the credentials are encoded and sent with the HTTP request header.

    • Bearer:

      • Explanation: Bearer authentication involves including a token in the request header to authenticate a request.

      • Usage: Commonly used with OAuth 2.0, where a token is obtained through the authorization process and then used to authenticate subsequent requests.

    • Oauth:

      • Explanation: OAuth (Open Authorization) is a protocol that allows third-party applications to access a user's resources without exposing their credentials.

      • Usage: Widely used for secure and delegated access to resources, particularly in scenarios where a user grants limited access to their account without sharing their password.

    • Oauth2:

      • Explanation: OAuth 2.0 is an updated version of OAuth and provides a more flexible and secure authorization framework.

      • Usage: It supports various authorization grants, allowing different types of applications to request and obtain authorization in different ways.

    • None:

      • Explanation: Choosing "None" as the authorization type means no specific authorization mechanism is required for accessing the resource.

      • Usage: Appropriate for cases where the resource is publicly accessible without any authentication.

  8. Click Save.

IMPORTANT SECURITY NOTE: It is imperative to exercise caution and use credentials only for secure endpoints. Remote systems can potentially access and extract information from these credentials. Always prioritize data safety and limit credential usage to trusted and secure contexts.