social-common / pragma.account / IdentityProvider /

IdentityProvider #

interface IdentityProvider

Plugin interface used to authenticate users against a third party Identity Provider.

References

Functions #

NameSummary

validate

abstract suspend fun validate(providerToken: String): IdProviderAccount

Performs the necessary validation on the token and if it is valid, returns account information populated from the Identity Provider.

Properties #

NameSummary

canAuthenticate

abstract var canAuthenticate: Boolean

Determines whether an IdentityProvider is enabled for authentication.

separator

abstract var separator: String

Used by the Identity Provider to distinguish the display name from the discriminator. If the Identity Provider does not use discriminators, the separator should be an empty string.