Class UserApiKey
- java.lang.Object
-
- com.mongodb.stitch.core.auth.providers.userapikey.models.UserApiKey
-
public final class UserApiKey extends Object
A struct representing a user API key as returned by the Stitch client API.
-
-
Constructor Summary
Constructors Constructor Description UserApiKey(String id, String key, String name, Boolean disabled)
Constructs a user API key with the provided parameters.
-
-
-
Constructor Detail
-
UserApiKey
public UserApiKey(String id, String key, String name, Boolean disabled)
Constructs a user API key with the provided parameters.- Parameters:
id
- The id of the user API key as an ObjectId hex string.key
- The key itself.name
- The name of the key.disabled
- Whether or not the key is disabled.
-
-
Method Detail
-
getId
public ObjectId getId()
Returns the id of this API key.- Returns:
- the id of this API key.
-
getKey
@Nullable public String getKey()
Returns the key of this API key. This is only returned on the creation request for a key.- Returns:
- the key of this API key.
-
getName
public String getName()
Returns the name of the API key.- Returns:
- the name of the API key.
-
getDisabled
public Boolean getDisabled()
Returns whether or not this API key is disabled for login usage.- Returns:
- whether or not this API key is disabled for login usage.
-
-