Página inicial do Docs → Desenvolver aplicações → Atlas Device SDKs
Gerenciar chaves de API do usuário - Kotlin SDK
Nesta página
Você pode usar o SDK Kotlin para criar e gerenciar chaves de API do usuário que permitem que dispositivos ou serviços se comuniquem com o Realm em nome de um usuário existente sem exigir que o usuário se autentique novamente.
As chaves de API do usuário estão associadas a um objeto de usuário criado por outro provedor de autenticação não anônimo. Cada usuário pode associar até 20 chaves de usuário à sua conta.
Você pode gerenciar chaves por meio da interface user.apiKeyAuth .
Dica
As chaves de API do usuário não são iguais às chaves de API do servidor, que permitem que um usuário ou serviço se autentique diretamente com o Realm usando o fornecedor de autenticação de chave de API. Para saber mais sobre as chaves de API do servidor, consulte Autenticação de chaves de API.
Criar uma chave de API do usuário
Para criar uma nova chave API do usuário, passe um nome de chave exclusivo para ApiKeyAuth.create(). A chave criada será associada ao usuário conectado e pode ser usada para interagir com o Realm em seu nome. Não é possível criar chaves de API do usuário para usuários anônimos.
Aviso
Armazenar o valor da chave de API
O SDK só retorna o valor da chave de API do usuário quando você o cria. Certifique-se de armazenar o valor key com segurança para que você possa usá-lo para se conectar.
Se você perder ou não armazenar o valor do key , não haverá como recuperá-lo. Você precisará criar uma nova chave de API do usuário.
val user = app.currentUser!! val provider = user.apiKeyAuth // Create an API key for the logged-in user val key = provider.create("apiKeyName")
Pesquisar uma chave de API do usuário
Para obter uma lista de todas as chaves API do usuário associadas ao usuário conectado, ligue para ApiKeyAuth.fetchAll().
Para encontrar uma chave API de usuário específica para o usuário conectado, passe o id da chave para 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)
Habilitar ou desabilitar uma chave de API do usuário
Você pode habilitar ou desabilitar uma chave chamando ApiKeyAuth.enable() ou ApiKeyAuth.disable() com o id da chave. Você não pode usar chaves desativadas para fazer login em nome do usuário.
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)
Excluir uma chave de API do usuário
Para remover permanentemente uma chave de API de usuário específica, passe o id da chave para ApiKeyAuth.delete(). Você não pode recuperar chaves excluídas ou usá-las para fazer login em nome do usuário.
val user = app.currentUser!! val provider = user.apiKeyAuth // ... fetch the key to delete // Delete the specified API key provider.delete(key.id)