Accessing Users

Overview

When a new user signs up, Dynamic creates a new user record in the database including their general information, and verified credentials. You can access that user via a webhook, or using SDK specific methods.

User Created Webhook

One of the valid webhook events you can listen to is called user.created (learn more about event types here).

All you will need to get started is a server that can receive events, and then you can plug in that URL in the dashboard. Learn more about setting up the webhook step by step here.

SDK Specific Methods

React

handleAuthenticatedUser Handler

The args returned by handleAuthenticatedUser is a UserProfile.

React

<DynamicContextProvider
  settings={{
    handlers: {
      handleAuthenticatedUser: async (args) => {
        console.log("handleBeforeAuth was called", args);
        await customUserObjectProcess(args.user);
      },
    },
  }}
>
  {/* ... rest of your app ... */}
</DynamicContextProvider>

onAuthSuccess Event

The SDK exposes Events which allow you to hook into lifecycle events. One such event is onAuthSuccess, which runs when the user has successfully authenticated.

React

<DynamicContextProvider
  settings={{
    events: {
      onAuthSuccess: (args) => {
        console.log('user', args.user);
      }
    }
  }}
>
{/* ... rest of your app ... */}
</DynamicContextProvider>

useDynamicContext

Once placed anywhere inside the component tree that is wrapped by the DynamicContextProvider, the useDynamicContext hook will give you access to the user object.

React

import { useDynamicContext } from '@dynamic-labs/sdk-react-core';

function MyComponent() {
  const { user } = useDynamicContext();
  console.log('user', user);
  return <div>My Component</div>;
}

React Native

authSuccess Event

Listen to the authentication success event to access the user right after login:

React Native

import { dynamicClient } from '<path to client file>';

dynamicClient.auth.on('authSuccess', (user) => {
  console.log('user', user);
});

Accessing the current user

You can read the authenticated user directly from the client:

React Native

import { dynamicClient } from '<path to client file>';

const user = dynamicClient.auth.authenticatedUser;
console.log('user', user);

Or, if you’re using our React hooks for client reactivity:

React Native

import { useDynamic } from '<path to client file>';
import { View } from 'react-native';

function MyComponent() {
  const { auth } = useDynamic();
  console.log('user', auth.authenticatedUser);
  return <View />;
}

Javascript

Accessing the current user

import { createDynamicClient, isSignedIn } from '@dynamic-labs-sdk/client';

const dynamicClient = createDynamicClient({
  environmentId: 'YOUR_ENVIRONMENT_ID',
  metadata: {
    name: 'YOUR_APP_NAME',
    url: 'YOUR_APP_URL',
    iconUrl: 'YOUR_APP_ICON_URL',
  },
});

// Check if the user is signed in (authenticated user exists) or has a connected wallet
const signedIn = isSignedIn();
console.log('isSignedIn', signedIn);

// Get the current authenticated user (if authenticated)
const user = dynamicClient.user;
console.log('user', user);

Getting the user JWT (if not using cookie auth)

// If the user is authenticated and not using cookie auth, the JWT is available here
const jwt = dynamicClient.token;
console.log('jwt', jwt);

Swift

Coming soon.

Flutter

Coming soon.

User Format

This user record follows a specific format, which you can read all about in the User reference.

One important array inside that user object will be called verified_credentials. This is where you’ll find information about any and every associated “credential” for the user i.e. email, social, blockchain, passkey.

What next?

Click here to learn more about Verified Credentials