Skip to content

docs: add deprecation notice for UsersAPIClient in Management API example #990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
utkrishtsahu wants to merge 2 commits into
base: main
Choose a base branch
from
+4 −2
Open

docs: add deprecation notice for UsersAPIClient in Management API example #990

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7927fce
docs: add deprecation notice for UsersAPIClient in Management API exa…
utkrishtsahu Jun 25, 2026
413a957
docs: fix deprecation callouts for loginWithOTP and UsersAPIClient
sanchitmehtagit Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions EXAMPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,8 @@ authentication
### Login using MFA with One Time Password code

> ⚠️ **Deprecated** — `loginWithOTP`, `loginWithOOB`, `loginWithRecoveryCode`, and `multifactorChallenge` are deprecated and will be removed in the next major version. Use `MfaApiClient` instead — see the [MFA Flexible Factors Grant](#mfa-flexible-factors-grant) section below.
This call requires the client to have the *MFA* Client Grant Type enabled. Check [this article](https://auth0.com/docs/clients/client-grant-types) to learn how to enable it.

When you sign in to a multifactor authentication enabled connection using the `login` method, you receive an error standing that MFA is required for that user along with an `mfa_token` value. Use this value to call `loginWithOTP` and complete the MFA flow passing the One Time Password from the enrolled MFA code generator app.
Expand Down Expand Up @@ -511,8 +513,6 @@ authentication

> The default scope used is `openid profile email`. Regardless of the scopes set to the request, the `openid` scope is always enforced.
> **Note** : The MFA APIs in Authentication client has been deprecated. Use the new MFA Flexible Factors APIs
### MFA Flexible Factors Grant

> [!IMPORTANT]
Expand Down Expand Up @@ -3221,6 +3221,8 @@ params.put("screen_hint", "signup");

The client provides a few methods to interact with the [Users Management API](https://auth0.com/docs/api/management/v2/#!/Users).

> ⚠️ **Deprecated** — `UsersAPIClient` will be removed in the next major version.
Create a new instance passing the account and an access token with the Management API audience and the right scope:

```kotlin
Expand Down
Loading