Create & Manage User API Keys - React Native SDK

React Hooks

If you are using @realm/react, you can access a user's ApiKeyAuth client with the useUser() hook in a component wrapped by UserProvider.

import {useUser} from '@realm/react';

const user = useUser();
const createUserApiKey = async () => {
  const {_id, key, name, disabled} = await user?.apiKeys.create(apiKeyName);
  // ...Do something with API key like save it
  // or share it with external service that authenticates
  // on user's behalf.
};

Create a User API Key

To create a new user API key, pass a name that's unique among all of the user's API keys to ApiKeyAuth.create().

The SDK returns the value of the user API key when you create it. Make sure to store the key value securely so that you can use it to log in. If you lose or do not store the key value there is no way to recover it. You will need to create a new user API key.

You cannot create a user API key for a server API key or an anonymous user.

const {_id, key, name, disabled} = await user?.apiKeys.create(apiKeyName);

Look up a User API Key

To get an array that lists all of a user's API keys, call ApiKeyAuth.fetchAll().

To find a specific API key, pass the key's _id to ApiKeyAuth.fetch().

const getUserApiKey = async () => {
  // List all of a user's keys
  const keys = await user.apiKeys.fetchAll();
  // Get a specific key by its ID
  const key = await user!.apiKeys.fetch(apiKey!._id);
};

Enable or Disable an API Key

To enable or disable a user API key, pass the key's _id to ApiKeyAuth.enable() or ApiKeyAuth.disable(). When a key is disabled, it cannot be used to log in on behalf of the user.

await user!.apiKeys.enable(cloudApiKey!._id);

await user!.apiKeys.disable(cloudApiKey!._id);

Delete an API Key

To permanently delete a user API, pass the key's _id to ApiKeyAuth.delete(). Deleted keys cannot be recovered.

await user!.apiKeys.delete(cloudApiKey!._id);