Puede utilizar el SDK de Kotlin para crear y administrar Claves de API de usuario que permiten que los dispositivos o servicios se comuniquen con Realm en nombre de un usuario existente sin necesidad de que el usuario vuelva a autenticarse.
Las claves API de usuario están asociadas con un objeto de usuario creado por otro proveedor de autenticación no anónimo. Cada usuario puede asociar hasta 20 claves de usuario con su cuenta.
Puede administrar claves a través de la interfaz user.apiKeyAuth.
Tip
Las claves API de usuario no son lo mismo que las claves API de servidor, que permiten a un usuario o servicio autenticarse directamente con Realm mediante el proveedor de autenticación de claves API. Para obtener más información sobre las claves API de servidor, consulte Autenticación con claves API.
Create a User API Key
Para crear una nueva clave API de usuario, pasa un nombre de clave único a ApiKeyAuth.create(). La clave creada se asociará con el usuario que ha iniciado sesión y podrá usarse para interactuar con Realm en su nombre. No puedes crear claves API de usuario para usuarios anónimos.
Advertencia
Store the API Key Value
El SDK solo devuelve el valor de la clave API del usuario al crearla. Asegúrese de almacenarla. key valor de forma segura para que puedas usarlo para iniciar sesión.
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.
val user = app.currentUser!! val provider = user.apiKeyAuth // Create an API key for the logged-in user val key = provider.create("apiKeyName")
Look up a User API Key
Para obtener una lista de todas las claves API de usuario asociadas con el usuario que inició sesión, llame a ApiKeyAuth.fetchAll().
To find a specific user API key for the logged-in user, pass the key's id to ApiKeyAuth.fetch().
val user = app.currentUser!! val provider = user.apiKeyAuth // Get all keys for the logged-in user val apiKeys = provider.fetchAll() // Get a specific key by its ID val apiKey = provider.fetch(key.id)
Enable or Disable a User API Key
Puede habilitar o deshabilitar una clave llamando a ApiKeyAuth.enable() o ApiKeyAuth.disable() con el valor id de la clave. No puede usar claves deshabilitadas para iniciar sesión en nombre del usuario.
val user = app.currentUser!! val provider = user.apiKeyAuth // ... fetch the key to enable or disable // Enable an API key that's currently disabled provider.enable(key.id) // Disable an API key that's currently enabled provider.disable(key.id)
Delete a User API Key
To permanently remove a specific user API key, pass the key's id to ApiKeyAuth.delete(). You cannot recover deleted keys or use them to log in on behalf of the user.
val user = app.currentUser!! val provider = user.apiKeyAuth // ... fetch the key to delete // Delete the specified API key provider.delete(key.id)