Descope

Bug fixes
* **Automatic configuration of base URL**: Some Python frameworks require setting the base URL parameter manually to Descope's API. We have now fixed this behavior to automatically set the base URL correctly.

Breaking changes
* **PEP8 naming convention alignment**: We made sure our Python SDK is aligned to the PEP8 naming convention; this includes the following breaking changes:
* auth/webauthn.py - `transactionID` argument of the `sign_up_finish` function has changed to `transaction_id`
* management/jwt.py - `updateJWT` function has changed to `update_jwt`

Enhancements
* **Passwords for user authentication**: Descope now supports usage of passwords. You can design your authentication flow to include password authentication, update a user's password when expired, and more.
* **User testing utility for your E2E tests**: When using authentication methods such as OTP / Magic Link / Enchanted Link, it can get cumbersome to automatically test those as part of the app's testing process. To close this loop - we released a utility with which you can create test users. Those special users are enabled to generate codes or links without the need of 3rd party messaging services.
You can create, fetch and delete test users - all part of your integration tests code! More information, along with examples, can be found in the SDK's README.
* **Invite users via management commands**: Use the new `invite` User command to programmatically invite users to your project. Just like in the console, you can control which tenants and roles will be associated to the invited users.
* **Masked email and phone dynamic values**: We updated some of the authentication methods' responses to return a masked value of the user's verification identifier. Use the `masked_address` parameter when working with OTP / Magic Link / Enchanted Link to present it in Flow Screens or your own proprietary UI.
* **Pagination support for Users**: We now support the ability to paginate the `search_all` User response. Use the `page` parameter to define how many results should return in each page.
* **Documentation enhancements**: Tiny enhancements to our SDK's README.

Breaking changes
* **SameSite=Strict Cookies**: We changed the configuration of cookies so that they are `SameSite=Strict`.
For more information on how to configure custom domains correctly - visit our [documentation](https://docs.descope.com/manage/session/).
* **Naming alignments**: We aligned our naming in multiple places to be snake-case instead of camel-case, along with parameter naming alignment. These changes include:
* `loginOptions` > `login_options`
* `refreshToken` > `refresh_token`
* `DeliveryMethod.PHONE` > `DeliveryMethod.SMS`

Enhancements
* **JWT returns in `validate_session`**: The `validate_session` function will now return the parsed JWT response.
* **Upgraded SSO configuration options**: We upgraded SSO management function, so that they now support configuring the `domain` parameter, which is used for auto registering new users to a specific tenant, if their identifiers are from the defined domain.

Bug fixes
* **Logic fix in `validate_and_refresh_session` function**: A fix to allow either and not both actions in method was applied.

Breaking changes
* 🚨 **Session and Refresh token split** 🚨: Session validation and refresh have been split in order to allow more control over session management.
3 new functions have been added with a more predictable and straightforward behavior; the new functions have no optional parameters.

* `validate_session` - only validates the session.
* `refresh_session` - refreshes a session.
* `validate_and_refresh_session` - combines the two, validate and refresh as needed.


These function replace the following which have been removed:

* `validate_session_request` - replaced by `validate_and_refresh_session` with the change of requiring both tokens, and the two new functions added for more granular control.
* `refresh_token`: replaced by `refresh_session`, behavior remains with more consistent naming and input validation.


Enhancements
* **Documentation enhancements**: Additional explanations were added to our SDK's README.
* **Rate limiting**: In order to maintain our stable performance, and provide a good experience to all of our customers, we added SDK and API rate limits. You can read more [in our documentation](https://docs.descope.com/api/#rate-limits).

Breaking changes
* **Rename of External ID to Login ID**: In order to clarify and align the various user identifiers used in our system - we've decided to rename `externalId` to `login_id`.
* **Enchanted Link attribute change**: Updated the identifier attribute to `linkId`, to make it clearer for the Descoper to use.

Enhancements
* **Management APIs**: Various Management APIs were added to the package. This allows automation of actions on Users, Tenants, Access Keys and many more! 💯
Some cool functionalities include:
* Searching over all users
* Adding roles and permissions, and assigning them to a user
* Creating a tenant and configuriing its SAML mapping
* **Key Response structure update**: A `v2` of the key response API; in order to support other frameworks, such as OpenID Connect, the key response's structure was updated, and keys are now a sub-attribute of `keys`.
* Format in `v1`: `[{...}]`
* Format in `v2`: `{"keys": [{...}]}`
* **Custom Claims**: Custom Claims can now be added to the JWT, using the `updateJwt` API.
* **Readme updates**: Updated the README of the repo, to make newcomers' lives even easier than before!


Bug fixes
* **Username removed as parameter from SSO User Attributes Mapping**: `Username` was a deprecated parameter in the SSO User Attributes Mapping dropdown. We removed it to resolve the confusion.

What's Changed
* Change exchange to POST by dorsha in https://github.com/descope/python-sdk/pull/63
* Change access key and refresh session to POST by dorsha in https://github.com/descope/python-sdk/pull/64
* 1. adjust email_validator for the new version (disable call for dns q… by guyp-descope in https://github.com/descope/python-sdk/pull/65
* fix: use cov xml file for result by omercnet in https://github.com/descope/python-sdk/pull/62
* chore(deps): update dependency black to v22.10.0 by descope in https://github.com/descope/python-sdk/pull/67
* Extend API to support custom claims by aviadl in https://github.com/descope/python-sdk/pull/68
* Change SAML start to be post by dorsha in https://github.com/descope/python-sdk/pull/70
* Change oauth authorize to be post by dorsha in https://github.com/descope/python-sdk/pull/71
* Fix oauth/saml start to be POST with query params by dorsha in https://github.com/descope/python-sdk/pull/72
* Add useful headers by dorsha in https://github.com/descope/python-sdk/pull/73
* Stepup take 2 by aviadl in https://github.com/descope/python-sdk/pull/74
* Adjust jwt response for access key with authz by guyp-descope in https://github.com/descope/python-sdk/pull/75
* fix(deps): update dependency cryptography to v38.0.3 [security] by descope in https://github.com/descope/python-sdk/pull/76
* fix(deps): update dependency pyjwt to v2.6.0 by descope in https://github.com/descope/python-sdk/pull/77
* chore(deps): update dependency pytest-cov to v4 by descope in https://github.com/descope/python-sdk/pull/69
* chore(deps): update dependency pytest to v7.2.0 by descope in https://github.com/descope/python-sdk/pull/79
* Add webauthn SignUpOrIn function by shilgapira in https://github.com/descope/python-sdk/pull/80
* Have both logout and logout_all as optinos by slavikm in https://github.com/descope/python-sdk/pull/81
* Add MFA support by aviadl in https://github.com/descope/python-sdk/pull/82
* chore(deps): update dependency liccheck to v0.7.3 by descope in https://github.com/descope/python-sdk/pull/83
* Management by itaihanski in https://github.com/descope/python-sdk/pull/84
* Add issuer support as url by dorsha in https://github.com/descope/python-sdk/pull/85
* Get management key from env var or config params by shilgapira in https://github.com/descope/python-sdk/pull/87
* Enchanted link support by aviadl in https://github.com/descope/python-sdk/pull/86
* Ensure management key is set before passing calls to management APIs by shilgapira in https://github.com/descope/python-sdk/pull/90
* Set localhost as default base_url (instead of prod link) by guyp-descope in https://github.com/descope/python-sdk/pull/88
* update poetry lockfile by omercnet in https://github.com/descope/python-sdk/pull/89

New Contributors
* itaihanski made their first contribution in https://github.com/descope/python-sdk/pull/84

**Full Changelog**: https://github.com/descope/python-sdk/compare/0.2.0...0.3.0