5.7.0
Breaking Changes📦 auth0View on GitHub →
⚠ 2 breaking✨ 3 features🐛 2 fixes🔧 25 symbols
Summary
This release refactors branding identifiers to the theme resource, makes the `id` field optional on phone template types, and adds several new fields related to tenant settings, connection options, and client configurations. Bug fixes address missing error handling for 404 and 409 responses in specific API calls.
⚠️ Breaking Changes
- The `identifiers` parameter has been removed from `branding.update()`. The corresponding `identifiers` field has been removed from `GetBrandingResponseContent` and `UpdateBrandingResponseContent`. Branding identifier types are no longer exported from `auth0.management.types`. These settings now reside exclusively on the theme resource (`PATCH /api/v2/branding/themes/{id}`).
- The `id` field on `PhoneTemplate`, `GetPhoneTemplateResponseContent`, `CreatePhoneTemplateResponseContent`, `UpdatePhoneTemplateResponseContent`, and `ResetPhoneTemplateResponseContent` is now `Optional[str]` instead of a required `str`. Code accessing `.id` without a `None` check must be updated.
Migration Steps
- If you were using the `identifiers` parameter in `branding.update()`, migrate those settings to the theme resource.
- Update code accessing the `.id` field on `PhoneTemplate` related types to handle potential `None` values.
✨ New Features
- `security_headers` (CSP + XSS protection config), `country_codes` (phone identifier allow/deny list), and `include_session_metadata_in_tenant_logs` (`bool`) have been added to `GetTenantSettingsResponseContent` and `UpdateTenantSettingsResponseContent`.
- `id_token_session_expiry_supported` (`ConnectionIdTokenSessionExpirySupported`) has been added to `ConnectionOptionsCommonOidc` and `UpdateConnectionOptions`.
- The new optional field `invitation_landing_client_id` has been added to `ClientMyOrganizationPostConfiguration`, `ClientMyOrganizationPatchConfiguration`, and `ClientMyOrganizationResponseConfiguration`.
🐛 Bug Fixes
- Error handling for `GET /client-grants/{id}/organizations` has been improved; it now raises `NotFoundError` on a 404 status code instead of causing an unhandled parse error.
- Error handling for `PATCH /token-exchange-profiles/{id}` has been improved; it now raises `ConflictError` on a 409 status code when a profile with the same `subject_token_type` exists, instead of causing an unhandled parse error.
Affected Symbols
branding.updateGetBrandingResponseContentUpdateBrandingResponseContentauth0.management.types.BrandingIdentifiersauth0.management.types.UpdateBrandingIdentifiersauth0.management.types.BrandingPhoneDisplayauth0.management.types.UpdateBrandingPhoneDisplayauth0.management.types.BrandingLoginDisplayEnumauth0.management.types.BrandingPhoneFormattingEnumauth0.management.types.BrandingPhoneMaskingEnumauth0.management.types.UpdateBrandingLoginDisplayEnumauth0.management.types.UpdateBrandingPhoneFormattingEnumauth0.management.types.UpdateBrandingPhoneMaskingEnumPhoneTemplateGetPhoneTemplateResponseContentCreatePhoneTemplateResponseContentUpdatePhoneTemplateResponseContentResetPhoneTemplateResponseContentGetTenantSettingsResponseContentUpdateTenantSettingsResponseContentConnectionOptionsCommonOidcUpdateConnectionOptionsClientMyOrganizationPostConfigurationClientMyOrganizationPatchConfigurationClientMyOrganizationResponseConfiguration