docs: correct documentation for enforced authentication type (#25142)

This commit is contained in:
Coco Sheng
2026-04-10 18:43:54 -04:00
committed by GitHub
parent 58901207bd
commit 773567c6ca
2 changed files with 10 additions and 6 deletions

View File

@@ -505,15 +505,19 @@ events. For more information, see the [telemetry documentation](./telemetry.md).
## Authentication
You can enforce a specific authentication method for all users by setting the
`enforcedAuthType` in the system-level `settings.json` file. This prevents users
from choosing a different authentication method. See the
`security.auth.enforcedType` in the system-level `settings.json` file. This
prevents users from choosing a different authentication method. See the
[Authentication docs](../get-started/authentication.md) for more details.
**Example:** Enforce the use of Google login for all users.
```json
{
"enforcedAuthType": "oauth-personal"
"security": {
"auth": {
"enforcedType": "oauth-personal"
}
}
}
```

View File

@@ -294,7 +294,7 @@ describe('validateNonInterActiveAuth', () => {
expect(processExitSpy).not.toHaveBeenCalled();
});
it('succeeds if effectiveAuthType matches enforcedAuthType', async () => {
it('succeeds if effectiveAuthType matches enforcedType', async () => {
mockSettings.merged.security.auth.enforcedType = AuthType.USE_GEMINI;
process.env['GEMINI_API_KEY'] = 'fake-key';
const nonInteractiveConfig = createLocalMockConfig({});
@@ -308,7 +308,7 @@ describe('validateNonInterActiveAuth', () => {
expect(debugLoggerErrorSpy).not.toHaveBeenCalled();
});
it('exits if configuredAuthType does not match enforcedAuthType', async () => {
it('exits if configuredAuthType does not match enforcedType', async () => {
mockSettings.merged.security.auth.enforcedType = AuthType.LOGIN_WITH_GOOGLE;
const nonInteractiveConfig = createLocalMockConfig({
getOutputFormat: vi.fn().mockReturnValue(OutputFormat.TEXT),
@@ -334,7 +334,7 @@ describe('validateNonInterActiveAuth', () => {
);
});
it('exits if auth from env var does not match enforcedAuthType', async () => {
it('exits if auth from env var does not match enforcedType', async () => {
mockSettings.merged.security.auth.enforcedType = AuthType.LOGIN_WITH_GOOGLE;
process.env['GEMINI_API_KEY'] = 'fake-key';
const nonInteractiveConfig = createLocalMockConfig({