Package com.mongodb.stitch.core.auth

Interface StitchCredential

All Known Implementing Classes:

AnonymousCredential, CustomCredential, FacebookCredential, FunctionCredential, GoogleCredential, ServerApiKeyCredential, UserApiKeyCredential, UserPasswordCredential

public interface StitchCredential

A StitchCredential provides a Stitch client the information needed to log in or link a user with an identity.

Method Summary

Modifier and Type	Method	Description
Document	getMaterial()	Returns the authentication material for this credential.
ProviderCapabilities	getProviderCapabilities()	Returns the provider capabilities associated with this credential.
String	getProviderName()	Returns the authentication provider name that this credential is for.
String	getProviderType()	Returns the authentication provider type that this credential is for.

Method Detail

getProviderName

String getProviderName()

Returns the authentication provider name that this credential is for. (e.g. local-userpass for the User/Password authentication provider)

Returns:

the authentication provider name that this credential is for.

getProviderType

String getProviderType()

Returns the authentication provider type that this credential is for. (e.g. local-userpass for the User/Password authentication provider)

Returns:

the authentication provider type that this credential is for.

getMaterial

Document getMaterial()

Returns the authentication material for this credential. This is the authentication provider specific information if it's necessary. For example, this could be the username and password of an identity when using the User/Password authentication provider.

Returns:

the authentication material for this credential.

getProviderCapabilities

ProviderCapabilities getProviderCapabilities()

Returns the provider capabilities associated with this credential.

Returns:

the provider capabilities associated with this credential.