Realm Kotlin SDK - Sync/io.realm.kotlin.mongodb.auth/ApiKey

ApiKey

data class ApiKey
Content copied to clipboard

Class representing an API key for a User. An API key can be used to represent a user when logging in instead of using email and password. Note that the value of a key will only be available immediately after the key is created, after which point it is not visible anymore. This means that keys returned by ApiKeyAuth.fetch and ApiKeyAuth.fetchAll will have a nullvalue. Anyone creating an API key is responsible for storing it safely after that.

Parameters

id

an ObjectId uniquely identifying the key.

value

the value of this key, only returned when the key is created, null otherwise.

name

the name of the key.

enabled

whether the key is enabled or not.

Properties

enabled
Link copied to clipboard
val enabled: Boolean
Content copied to clipboard
id
Link copied to clipboard
val id: <ERROR CLASS>
Content copied to clipboard
name
Link copied to clipboard
val name: String
Content copied to clipboard
value
Link copied to clipboard
val value: String?
Content copied to clipboard