Releases: adobe-apiplatform/umapi-client.py
Releases · adobe-apiplatform/umapi-client.py
umapi-client v3.0.1
Fixes
- d22a6c4 Suppress log messages - can be enabled by library consumer if desired
umapi-client v3.0
Changes in Version 3
This is a major release and contains many compatibility-breaking changes. Chief
among these is an ovehaul of the auth layer and the the introduction of the
OAuthS2S auth class which authenticates UMAPI clients using
Server-to-Server
authentication. JWT-based authentication functionality is deprecated.
Refer to the user guide for details:
https://adobe-apiplatform.github.io/umapi-client.py/v3/
Summary of Changes
- Authentication Interface
- New
AuthBaseto cover basic auth functionality - Old JWT stuff rolled into single
JWTAuthclass - New
OAuthS2Sclass representing new Server-to-Server authentication method
- New
- Connection Interface
- Removed
auth_dictfunctionality AuthBase-derived object must be passed toConnectionconstructor via
authparameter- Removed
ims_hostandims_endpoint_jwt- these areAuthBaseattributes user_management_endpointrenamed toendpoint- Removed
loggerparam - Changes to timeout and retry constructor params
- Renamed
retry_max_attemptstomax_retries - Removed
retry_first_delay - Removed
retry_random_delay timeout_secondsrenamed totimeout
- Renamed
- Removal of "throttling" params
throttle_actionsthrottle_commandsthrottle_groups
- Removed
- Removed Deprecated Enums
GroupTypesRoleTypes
- Enum Naming Tweaks
IdentityTypes->IdentityTypeIfAlreadyExistsOptions->IfAlreadyExistsOption
UserActionChanges- Constructor Updates
- Replaced
emailandusernameparams withuserparam that models the
userfield in a UMAPI action command object. This can be username or
email address depending on context. - Removed
id_typefield. Identity type is only needed when creating a new
user. - Refactor some validation to
create()
- Replaced
create()Updatesemailis now mandatory- Add
id_typeparameter - Perform some validation that was done in the constructor
update()Updates- Country code is not a valid user update parameter
add_to_groups()Updates- It isn't possible to assign a user to all group
- Group type is deprecated
remove_from_groups()Updates- Group type is deprecated
add_role()andremove_role()were removed because role-based
functionality is deprecated in the API- Country code removed from
update()because UMAPI does not support
country code updates
- Constructor Updates
UserQueryUpdates- Change
emailparam in constructor touser_stringto reflect UMAPI
terminology. Adddomainparameter which is supported by UMAPI.
- Change
UsersQueryUpdates- Remove
identity_typeparameter from constructor. The UMAPI has never
supported filtering users by identity type.
- Remove
- Rename
UserGroupActiontoGroupAction GroupActionChangesproductsparamter inadd_to_products()andremove_from_products()is
mandatory- It isn't possible to add all products to a group or remove all (without
enumerating every product profile inproducts) usersparameter inadd_users()andremove_users()is mandatory
UserGroupsQueryclass removed because theuser-groupUMAPI endpoint does
not exist- Deleted
legacy.py
umapi-client v2.22
- 4a5773f allow username to be updated by itself
umapi-client v2.21
umapi-client v2.20
- #103 Create users with email-type usernames that differ from email address in a single call
umapi-client v2.19
umapi-client v2.18
umapi-client v2.17.1
No updates to functionality, just changes to the build system.
- #90 Switch from setup.py to Poetry
umapi-client v2.17
umapi-client v2.16
#83 - Implement ssl_verify for authentication endpoint