Skip to content

Commit 3dc5405

Browse files
Docs: Update for Node SDK 0.147.0
1 parent d2b4dcd commit 3dc5405

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

‎auth/configuration.mdx‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -572,20 +572,28 @@ _ = auth
572572

573573
Set `browser.region` to choose where Managed Auth runs the connection's initial login, health checks, and automatic reauthentication. Choose from `us-east`, `eu-west`, and `ap-southeast`. Region selection is available on [Start-Up and Enterprise plans](/info/pricing); omitted values default to `us-east`.
574574

575+
Set `browser.location.locale` to a supported canonical BCP 47 locale, such as `sv-SE`, for the browser language and `Accept-Language` header in login, health-check, and reauthentication sessions. Omit it when creating a connection to use the browser region's default locale.
576+
575577
<CodeGroup>
576578
```typescript TypeScript
577579
const auth = await kernel.auth.connections.create({
578580
domain: 'example.com',
579581
profile_name: 'my-profile',
580-
browser: { region: 'eu-west' },
582+
browser: {
583+
region: 'eu-west',
584+
location: { locale: 'sv-SE' },
585+
},
581586
});
582587
```
583588

584589
```python Python
585590
auth = await kernel.auth.connections.create(
586591
domain="example.com",
587592
profile_name="my-profile",
588-
browser={"region": "eu-west"},
593+
browser={
594+
"region": "eu-west",
595+
"location": {"locale": "sv-SE"},
596+
},
589597
)
590598
```
591599

@@ -596,6 +604,9 @@ auth, err := client.Auth.Connections.New(ctx, kernel.AuthConnectionNewParams{
596604
ProfileName: "my-profile",
597605
Browser: kernel.ManagedAuthBrowserConfigParam{
598606
Region: kernel.ManagedAuthBrowserConfigRegionEuWest,
607+
Location: kernel.ManagedAuthBrowserLocationParam{
608+
Locale: kernel.String("sv-SE"),
609+
},
599610
},
600611
},
601612
})
@@ -606,7 +617,7 @@ _ = auth
606617
```
607618
</CodeGroup>
608619

609-
Updating `browser.region` changes the connection default for browsers created afterward. It doesn't move or restart an active login, health check, or reauthentication browser.
620+
Updating `browser.region` or `browser.location.locale` changes the connection default for browsers created afterward. It doesn't move or restart an active login, health check, or reauthentication browser. When you update the locale, omit `locale` to keep its current value or set it to `null` to clear the override and return to the region's default. You can't override the locale on `.login()`.
610621

611622
You can override the connection region for one login without changing its default:
612623

@@ -919,6 +930,7 @@ After creating a connection, you can update its configuration with `auth.connect
919930
| `save_credentials` | Whether to save credentials on successful login |
920931
| `record_session` | Record a [replay](/browsers/replays) of every auth browser session for this connection (logins, health checks, and reauths) |
921932
| `browser.region` | Region for login, health-check, and reauth browsers. Takes effect on the next browser created for the connection |
933+
| `browser.location.locale` | Canonical BCP 47 locale for login, health-check, and reauth browsers. Omit it on update to keep the current value, or set it to `null` to use the region's default |
922934
| `proxy` | Pin login, health-check, and reauth sessions to a proxy. Takes effect on the next health check or reauth |
923935

924936
Only the fields you include are updated—everything else stays the same. Changes to `health_check_interval`, `health_checks`, `auto_reauth`, and `proxy` take effect immediately on the running connection.

0 commit comments

Comments
 (0)