auth-kt/io.github.jan.supabase.auth.oauth

Package-level declarations

Types

Interface for the OAuth 2.1 authorization server methods. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth. Used to implement the authorization code flow on the consent page.

OAuthAuthorizationClient

@Serializable

data class OAuthAuthorizationClient(val id: String, val name: String, val uri: String? = null, val logoUri: String? = null)

OAuth client details in an authorization request. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

OAuthAuthorizationDetails

@Serializable

data class OAuthAuthorizationDetails(val authorizationId: String, val redirectUri: String, val client: OAuthAuthorizationClient, val user: OAuthAuthorizationUser, val scope: String) : OAuthAuthorizationDetailsResponse

OAuth authorization details when user needs to provide consent. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

OAuthAuthorizationDetailsResponse

@Serializable(with = OAuthAuthorizationDetailsResponse.Companion::class)

sealed interface OAuthAuthorizationDetailsResponse

Response type for getting OAuth authorization details. Possible subclasses: full authorization details (if consent needed) or redirect URL (if already consented). Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

OAuthAuthorizationUser

@Serializable

data class OAuthAuthorizationUser(val id: String, val email: String)

Information about the OAuthAuthorizationUser

OAuthGrant

@Serializable

data class OAuthGrant(val client: OAuthAuthorizationClient, val scopes: List<String>, val grantedAt: Instant)

An OAuth grant representing a user's authorization of an OAuth client. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

OAuthRedirect

@Serializable

data class OAuthRedirect(val redirectUrl: String) : OAuthAuthorizationDetailsResponse

OAuth redirect response when user has already consented or after consent decision. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.