auth-kt/io.github.jan.supabase.auth.admin.custom.provider/CustomProviderBuilder

CustomProviderBuilder

@Serializable

class CustomProviderBuilder(source)

Parameters for creating a new custom provider.

Constructors

CustomProviderBuilder

constructor()

Properties

acceptableClientIds

@SerialName(value = "acceptable_client_ids")

var acceptableClientIds: List<String>?

Additional client IDs accepted during token validation

attributeMapping

@SerialName(value = "attribute_mapping")

var attributeMapping: JsonObject?

Mapping of provider attributes to Supabase user attributes

authorizationParams

@SerialName(value = "authorization_params")

var authorizationParams: JsonObject?

Additional parameters sent with the authorization request

authorizationUrl

@SerialName(value = "authorization_url")

var authorizationUrl: String?

OAuth2 authorization URL

@SerialName(value = "client_id")

var clientId: String?

OAuth client ID

@SerialName(value = "client_secret")

var clientSecret: String?

OAuth client secret (write-only, not returned in responses)

customClaimsAllowlist

@SerialName(value = "custom_claims_allowlist")

var customClaimsAllowlist: List<String>?

Allowlist of raw identity provider claim keys to copy verbatim into the user's custom_claims field (within identity_data and raw_user_meta_data), e.g. ["groups", "org_id", "mail"]. This is an opt-in allowlist that defaults to empty (no claims captured) and operates independently from attribute_mapping.

@SerialName(value = "discovery_url")

var discoveryUrl: String?

OIDC discovery URL

@SerialName(value = "email_optional")

var emailOptional: Boolean?

Whether email is optional for this provider

var enabled: Boolean?

Whether the provider is enabled

var identifier: String?

Provider identifier (e.g. custom:mycompany)

var issuer: String?

OIDC issuer URL

@SerialName(value = "jwks_uri")

var jwksUri: String?

JWKS URI for token verification

var name: String?

Human-readable name

@SerialName(value = "pkce_enabled")

var pkceEnabled: Boolean?

Whether PKCE is enabled

@SerialName(value = "provider_type")

var providerType: CustomProviderType?

Provider type

var scopes: List<String>?

OAuth scopes requested during authorization

@SerialName(value = "skip_nonce_check")

var skipNonceCheck: Boolean?

Whether to skip nonce check (OIDC)

@SerialName(value = "token_url")

var tokenUrl: String?

OAuth2 token URL

@SerialName(value = "userinfo_url")

var userinfoUrl: String?

OAuth2 userinfo URL