Skip to content

IDE-5298: Improve federated auth error message to include AH_ORGANIZATION_UUID guidance #2031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
deepakmishra2 wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

IDE-5298: Improve federated auth error message to include AH_ORGANIZATION_UUID guidance #2031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fa2c09f
IDE-5298: Improve federated auth error message to include AH_ORGANIZA…
deepakmishra2 Jul 30, 2026
017c7c1
IDE-5298: Replace unsafe <uuid> style tag placeholder with YOUR_ORG_UUID
Copilot Jul 30, 2026
dfe7633
Merge branch 'main' into IDE-5298
deepakmishra2 Aug 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/EventListener/ExceptionListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,12 @@ public function onConsoleError(ConsoleErrorEvent $event): void
break;
case "This resource requires additional authentication.":
$this->helpMessages[] = "This is likely because you have Federated Authentication required for your organization.";
$this->helpMessages[] = "Run `acli login` to authenticate via API token and then try again.";
if (getenv('AH_ORGANIZATION_UUID')) {
$this->helpMessages[] = "`AH_ORGANIZATION_UUID` is already set in your environment. Run `acli auth:login` to configure API credentials, then retry.";
} else {
$this->helpMessages[] = "First, export your organization UUID: `export AH_ORGANIZATION_UUID=YOUR_ORG_UUID`. Find your UUID at https://cloud.acquia.com/a/organizations";
$this->helpMessages[] = "Then run `acli auth:login` to configure API credentials and retry.";
}
$this->helpMessages[] = "Get help for this error at https://docs.acquia.com/acquia-cloud-platform/add-ons/acquia-cli/known-issues#federated-authentication-does-not-work";
break;
default:
Expand Down
35 changes: 34 additions & 1 deletion tests/phpunit/src/Misc/ExceptionListenerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use AcquiaCloudApi\Exception\ApiErrorException;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Event\ConsoleErrorEvent;
use Symfony\Component\Console\Exception\RuntimeException;
Expand Down Expand Up @@ -127,7 +128,8 @@ public static function providerTestHelp(): array
]),
[
'This is likely because you have Federated Authentication required for your organization.',
'Run `acli login` to authenticate via API token and then try again.',
'First, export your organization UUID: `export AH_ORGANIZATION_UUID=YOUR_ORG_UUID`. Find your UUID at https://cloud.acquia.com/a/organizations',
'Then run `acli auth:login` to configure API credentials and retry.',
'Get help for this error at https://docs.acquia.com/acquia-cloud-platform/add-ons/acquia-cli/known-issues#federated-authentication-does-not-work',
],
],
Expand All @@ -150,4 +152,35 @@ public static function providerTestHelp(): array
],
];
}

#[Group('serial')]
public function testFederatedAuthHelpWithOrgUuidAlreadySet(): void
{
putenv('AH_ORGANIZATION_UUID=647fb0ca-8903-4e45-bbca-9472d8efafcb');
try {
$exceptionListener = new ExceptionListener();
$commandProphecy = $this->prophet->prophesize(Command::class);
$applicationProphecy = $this->prophet->prophesize(Application::class);
$messages = [
'<options=bold>How to fix it:</> This is likely because you have Federated Authentication required for your organization.',
'`AH_ORGANIZATION_UUID` is already set in your environment. Run `acli auth:login` to configure API credentials, then retry.',
'Get help for this error at https://docs.acquia.com/acquia-cloud-platform/add-ons/acquia-cli/known-issues#federated-authentication-does-not-work',
'You can find Acquia CLI documentation at https://docs.acquia.com/acquia-cli/',
'You can submit a support ticket at https://support-acquia.force.com/s/contactsupport' . PHP_EOL . 'Re-run the command with the <bg=blue;fg=white;options=bold>-vvv</> flag and include the full command output in your support ticket.',
];
$applicationProphecy->setHelpMessages($messages)->shouldBeCalled();
$commandProphecy->getApplication()->willReturn($applicationProphecy->reveal());
$commandProphecy->getName()->willReturn('ide:wizard:ssh-key:create-upload');
$error = new ApiErrorException((object) [
'error' => '',
'message' => 'This resource requires additional authentication.',
]);
$consoleErrorEvent = new ConsoleErrorEvent($this->input, $this->output, $error, $commandProphecy->reveal());
$exceptionListener->onConsoleError($consoleErrorEvent);
$this->prophet->checkPredictions();
self::assertTrue(true);
} finally {
putenv('AH_ORGANIZATION_UUID');
}
}
}
Loading