Class ApiKey
On this page
io.realm.mongodb.auth
Class representing an API key for a User . An API can be used to represent the user when logging instead of using email and password.
These keys are created or fetched through ApiKeyAuth.create(String) or the various fetch -methods.
Note that a keys value is only available when the key is created, after that it is not visible. So anyone creating an API key is responsible for storing it safely after that.
Method Summary
Modifier and Type | Method and Description |
|---|---|
public boolean | |
public ObjectId | getId () Returns the unique identifier for this key. |
public String | getName () Returns the name of this key. |
public String | getValue () Returns this keys value. |
public int | hashCode () |
public boolean | isEnabled () Returns whether or not this key is currently enabled. |
public String | toString () |
Inherited Methods
Methods inherited from class java.lang.Object :
getClass,hashCode,equals,clone,toString,notify,notifyAll,wait,wait,wait,finalize
Method Detail
equals
getId
public ObjectId getId () |
|---|
Returns the unique identifier for this key. Returns the id, uniquely identifying the key. |
getName
getValue
hashCode
isEnabled
public boolean isEnabled () |
|---|
Returns whether or not this key is currently enabled. Returns if the key is enabled or not. |