Skip to content

docs(myaccount): mark the My Account Profile API as Beta #779

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

Merged
siddhikotak merged 1 commit into from
Nov 6, 2026
Merged

docs(myaccount): mark the My Account Profile API as Beta #779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 @@ -2885,10 +2885,12 @@ Enrollment is a two-step flow: request a challenge, then verify the credential.
</script>
```

### Profile
<a id="profile"></a>

### Profile [Beta]

> [!NOTE]
> My Account Profile API support via SDKs is currently in Early Access. To request access to this feature, contact your Auth0 representative.
> The My Account Profile API is currently in [Beta](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#beta). It might change before General Availability, and Auth0 does not support beta functionality for production use. The feature must be enabled for your tenant.

Read and update the current user's profile. `getUserProfile()` needs the `read:me:profile` scope, and `updateUserProfile()` needs `update:me:profile`. Add the scopes your app uses to the `scope` in your `authorizationParams` (see [Setup](#setup-3)).

Expand Down
6 changes: 6 additions & 0 deletions src/interfaces/auth0-vue-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,12 @@ export interface Auth0VueClient {
* `getUserProfile()` and `update:me:profile` for `updateUserProfile()`).
* Use MRRT to exchange a refresh token for a scoped access token if needed.
*
* **Note:** `getUserProfile()` and `updateUserProfile()` are currently in
* [Beta](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#beta).
* They might change before General Availability, and Auth0 does not support
* beta functionality for production use. The feature must be enabled for
* your tenant.
*
* ```js
* const { myAccount } = useAuth0();
*
Expand Down
Loading