oauth2/com.okta.oauth2/ResourceOwnerFlow

ResourceOwnerFlow

class ~~ResourceOwnerFlow~~(client: OAuth2Client)

Deprecated

The Android-only ResourceOwnerFlow is deprecated in favor of the KMP variant, which works on Android and JVM. Use com.okta.oauth2.kmp.ResourceOwnerFlow instead. This class will be removed in a future major release.

An authentication flow class that implements the Resource Owner Flow exchange.

This simple authentication flow permits a user to authenticate using a simple username and password. As such, the configuration is straightforward.

Important: Resource Owner authentication does not support MFA or other more secure authentication models, and is not recommended for production applications.

Constructors

ResourceOwnerFlow

constructor(client: OAuth2Client)

constructor()

Initializes a resource owner flow.

constructor(oidcConfiguration: OidcConfiguration)

Initializes a resource owner flow using the OidcConfiguration.

Types

Companion

object Companion

Functions

start

suspend fun ~~start~~(username: String, password: String, scope: String = client.configuration.defaultScope): OAuth2ClientResult<Token>

suspend fun start(username: String, password: String, scope: List<String>): OAuth2ClientResult<Token>

Initiates the Resource Owner flow.