library/xyz.malefic.koven.auth/OAuthProvider

OAuthProvider

interface OAuthProvider

An interface for defining OAuth2 providers.

Inheritors

Types

object Companion

data class Generic(val name: String, val authEndpoint: String, val tokenEndpoint: String, val userInfoEndpoint: String?, val idPath: List<String>, val usernamePath: List<String>, val emailPath: List<String>, val defaultScopes: List<String> = listOf("openid", "profile", "email")) : OAuthProvider

A generic OAuth2 provider that can be configured at runtime.

data object GitHub : OAuthProvider

Standard GitHub OAuth2 provider.

data object Google : OAuthProvider

Standard Google OAuth2 provider.

data class Microsoft(val tenant: String = "common") : OAuthProvider

Standard Microsoft (Entra ID) OAuth2 provider.

Properties

abstract val authEndpoint: String

open val defaultScopes: List<String>

abstract val emailPath: List<String>

The path to the user's email in the user info JSON.

abstract val idPath: List<String>

The path to the user's unique ID in the user info JSON.

abstract val name: String

abstract val tokenEndpoint: String

userInfoEndpoint

abstract val userInfoEndpoint: String?

abstract val usernamePath: List<String>

The path to the user's username in the user info JSON.

Functions

open fun parseUserInfo(json: String): Triple<String, String, String>

Parses the user info JSON from the provider and returns a triple of (providerUserId, username, email).