Users
You can manage your users in the Clerk Dashboard, or in your app.
Manage users in the Clerk Dashboard
To manage users in the Clerk Dashboard, navigate to the Users page.
Manage users in your app
You can manage users in your app either through the frontend or backend. But first, it's important to understand the User
object.
The User
object holds all of the information for a single user of your application and provides a set of methods to manage their account. Each User
has at least one authentication identifier, which might be their email address, phone number, or a username.
A user can be contacted at their primary email address or primary phone number. They can have more than one registered email address, but only one of them will be their primary email address. This goes for phone numbers as well; a user can have more than one, but only one phone number will be their primary. At the same time, a user can also have one or more external accounts by connecting to social providers such as Google, Apple, Facebook, and many more.
Finally, a User
object holds profile data like the user's name, profile picture, and a set of metadata that can be used internally to store arbitrary information. The metadata are split into publicMetadata
and privateMetadata
. Both types are set from the Backend API, but public metadata can also be accessed from the Frontend API.
For more information on the User
object, such as helper methods for retrieving and updating user information and authentication status, see the reference docs. The User
object is also available in the backend, but it looks slightly different. For more information, see the Backend User
object reference docs.
Manage users in the frontend
Depending on the level of abstraction you need, you can manage users in the frontend using Clerk's prebuilt components, React hooks, or lower-level JavaScript methods.
- Prebuilt components: Clerk provides the prebuilt components
<UserButton />
and<UserProfile />
to help your users manage their profile data. - Hooks: Because Clerk's React-based SDKs are built on top of the Clerk React SDK, you can use the hooks that the React SDK provides. These hooks include access to the
User
object and helpful methods for managing user authentication and profile data. - JavaScript methods: If Clerk's prebuilt components don't meet your specific needs or if you require more control over the logic, you can rebuild the existing Clerk flows using the Clerk API. For more information, see the custom flow guides.
Manage users in the backend
The JavaScript Backend SDK exposes the Backend API resources and low-level authentication utilities for JavaScript environments.
There are many operations available for managing users, such as getUser()
, createUser()
, and deleteUser()
. For more information, see the Backend SDK reference docs.
Feedback
Last updated on