Use case: Delete a Jira Server Configuration

Before you start

  1. Verify Permissions: Ensure you have the appropriate permissions in your Unity Organization to delete a Jira ServerConfig. Typically, you must be an admin or have specific collaboration settings access.
  2. Organization Context: Know the Organization identifier (GUID) of the Unity Organization from which the configuration should be deleted.
  3. Jira ServerConfig ID: You'll need the unique identifier (GUID) of the Jira ServerConfig you wish to delete.
  4. Understand Impact: Deleting a Jira ServerConfig removes access to all associated Jira projects and configurations. Make sure no active integrations depend on this configuration.
  5. Check for Linked Projects: Unlink any Unity projects that are connected to this Jira ServerConfig before proceeding to avoid broken references.

How do I...?

To delete a Jira ServerConfig, follow these steps:

  1. Get the Organization ID: Identify the Unity Organization where the Jira ServerConfig is registered.
  2. Get the Jira ServerConfig ID: Ensure you have the correct ServerConfig ID from the list of configurations.
  3. Use the SDK: Call the DeleteServerConfigAsync method in the Unity Collaboration SDK with the required properties.
  4. Handle Responses: Ensure your implementation verifies whether the config was successfully deleted and handles any errors appropriately.

Example:

await jiraConfigService.DeleteServerConfigAsync(
    organizationId: organizationId,
    jiraServerConfigId: jiraServerConfigId,
    cancellationToken: cancellationToken);

Error Handling

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