Skip to content

UPGRADING.md

Latest commit

 

History

History
157 lines (117 loc) · 5.88 KB

UPGRADING.md

File metadata and controls

157 lines (117 loc) · 5.88 KB
Raw

v6 Migration Guide

A guide to migrating the Auth0 Python SDK from v5 to v6.

Overall changes

v6 removes one deprecated Management API surface (federated connections tokensets) and tightens a handful of generated types to match the current Auth0 Management API contract. Most applications will only be affected if they use the specific types or endpoints listed below.

The Authentication API is not affected by this release.

Breaking changes

Federated connections tokensets removed

The users.federated_connections_tokensets sub-client and its list/delete methods have been removed, along with the FederatedConnectionTokenSet and ConnectionFederatedConnectionsAccessTokens types. This endpoint is no longer part of the Auth0 Management API.

# v5
client.users.federated_connections_tokensets.list(id="user_id")
client.users.federated_connections_tokensets.delete(id="user_id", tokenset_id="tokenset_id")
# v6
# No replacement — the endpoint has been removed from the Management API.

If you depend on this functionality, do not upgrade until you have confirmed an alternative with Auth0 support.

federated_connections_access_tokens field removed

The optional federated_connections_access_tokens field has been removed from:

  • ConnectionOptionsAzureAd
  • ConnectionOptionsCommonOidc
  • ConnectionOptionsGoogleApps
  • ConnectionPropertiesOptions
  • UpdateConnectionOptions

Any code reading or setting this field on the above types will need to remove that usage. Note that these models are configured with extra="allow", so passing federated_connections_access_tokens is not silently dropped — it is retained on the model and still serialized into the outbound request. Remove the field explicitly rather than relying on the SDK to strip it.

read:federated_connections_tokens / delete:federated_connections_tokens scopes removed

These two values are no longer valid members of OauthScope. Remove any references to them when requesting or checking scopes.

ClientSessionTransferDelegationDeviceBindingEnum narrowed

The "asn" literal value has been removed. The enum now only accepts "ip":

# v5
ClientSessionTransferDelegationDeviceBindingEnum = typing.Union[typing.Literal["ip", "asn"], typing.Any]
# v6
ClientSessionTransferDelegationDeviceBindingEnum = typing.Union[typing.Literal["ip"], typing.Any]

If you were setting this value to "asn", update it to "ip" — this matches the current Management API's accepted values.

ConnectionAttributeIdentifier split into three types

ConnectionAttributeIdentifier has been removed with no compatibility alias. It is replaced by three narrower types, one per attribute:

Attribute field v5 type v6 type Shape
EmailAttribute.identifier ConnectionAttributeIdentifier EmailAttributeIdentifier {active?, default_method?: DefaultMethodEmailIdentifierEnum}
PhoneAttribute.identifier ConnectionAttributeIdentifier PhoneAttributeIdentifier {active?, default_method?: DefaultMethodPhoneNumberIdentifierEnum}
UsernameAttribute.identifier ConnectionAttributeIdentifier UsernameAttributeIdentifier {active?} (no default_method) 
# v5
from auth0.management.types import ConnectionAttributeIdentifier

identifier = ConnectionAttributeIdentifier(active=True, default_method="email_otp")
# v6
from auth0.management.types import EmailAttributeIdentifier

identifier = EmailAttributeIdentifier(active=True, default_method="email_otp")

EmailAttributeIdentifier has the same shape as the old ConnectionAttributeIdentifier and is a drop-in replacement for code that was only ever used with EmailAttribute. Code using ConnectionAttributeIdentifier with PhoneAttribute or UsernameAttribute must switch to PhoneAttributeIdentifier or UsernameAttributeIdentifier respectively; UsernameAttributeIdentifier does not support default_method.

PhoneProviderProtectionBackoffStrategyEnum value renamed

The "none" literal has been replaced with "default":

# v5
PhoneProviderProtectionBackoffStrategyEnum = typing.Union[typing.Literal["exponential", "none"], typing.Any]
# v6
PhoneProviderProtectionBackoffStrategyEnum = typing.Union[typing.Literal["exponential", "default"], typing.Any]

Replace any use of "none" with "default".

ListRolesOffsetPaginatedResponseContent pagination fields now required

start, limit, and total are no longer optional:

# v5
start: typing.Optional[float] = None
limit: typing.Optional[float] = None
total: typing.Optional[float] = None
# v6
start: float
limit: float
total: float

Deserializing a role-list response that is missing any of these fields now raises pydantic.ValidationError instead of silently defaulting to None. This matches the Management API, which always returns these fields for this endpoint.