Use case: Check Jira Server Credentials

Before you start

  1. Verify Permissions: Ensure you have permission to configure Jira integrations in your Unity Organization. Typically, this means being an admin or having specific collaboration settings access.
  2. Organization Context: Know the Organization identifier (GUID) of the Unity Organization where the Jira server is being configured.
  3. Jira Server Details: Prepare the Jira server URL, username, and key (API token or password) to test.

How do I...?

To check if Jira server credentials are valid:

  1. Get the Organization ID: Identify the Unity Organization where the Jira server is being configured.
  2. Prepare the credentials: Gather the Jira server URL, username, and key.
  3. Use the SDK: Call the CheckCredentialsAsync method in the Unity Collaboration SDK with the required properties.
  4. Handle the Response: Confirm that the credentials are valid and the server is accessible.

Example:

await jiraManagementService.CheckCredentialsAsync(
    organizationId: organizationId,
    url: jiraServerUrl,
    username: jiraUsername,
    key: jiraKey,
    cancellationToken: cancellationToken);

Error Handling

  • 400 Bad Request: Invalid input or credentials.
  • 401 Unauthorized: Authentication required.
  • 403 Forbidden: Insufficient permissions.