ai-elements-core/dev.ai.elements.core.auth/OAuthProvider

OAuthProvider

@Serializable

enum OAuthProvider : Enum<OAuthProvider> (source)

Sign-in methods the app can offer, and what each one produces.

OPENROUTER is OpenRouter's documented flow for third-party apps and yields an ordinary API key. The others are subscription sign-ins: they reuse the public OAuth client of each vendor's own command-line tool to use the user's consumer plan. Vendors may consider that outside their terms, may revoke those clients at any time, and may restrict accounts that use them — which is why the demo keeps them behind an explicit, warned opt-in. (Claude.ai subscriptions are deliberately absent: Anthropic only permits them in its own products.)

Entries

Types

Companion

object Companion

Properties

baseUrl

val baseUrl: String

defaultModel

val defaultModel: String

entries

val entries: EnumEntries<OAuthProvider>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

experimental

val experimental: Boolean

A subscription sign-in through another tool's client (see the class doc).

flow

val flow: SignInFlow

How the user signs in.

kind

val kind: ProviderKind

label

val label: String

name

val name: String

ordinal

val ordinal: Int

Functions

apiHeaders

fun apiHeaders(tokens: OAuthTokens): Map<String, String>

Headers the API needs besides Authorization: Bearer <access token>.

valueOf

fun valueOf(value: String): OAuthProvider

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<OAuthProvider>

Returns an array containing the constants of this enum type, in the order they're declared.