Struct OAuth2PasswordRequestForm 

pub struct OAuth2PasswordRequestForm {
    pub grant_type: Option<String>,
    pub username: String,
    pub password: String,
    pub scope: String,
    pub client_id: Option<String>,
    pub client_secret: Option<String>,
}

OAuth2 password request form data.

Extracts the standard OAuth2 password grant fields from a application/x-www-form-urlencoded request body, matching FastAPI’s OAuth2PasswordRequestForm.

Fields

• grant_type: Optional, should be "password" per spec (not enforced here; use OAuth2PasswordRequestFormStrict for strict validation).
• username: Required.
• password: Required.
• scope: Space-separated scopes (empty string if not provided).
• client_id: Optional.
• client_secret: Optional.

Computed

• scopes(): Returns the scope string split into a Vec<String>.

Example

use fastapi_core::OAuth2PasswordRequestForm;

async fn login(form: OAuth2PasswordRequestForm) -> Response {
    let username = &form.username;
    let password = &form.password;
    let scopes = form.scopes();
    // ... authenticate user ...
}

Fields

grant_type: Option<String>

The grant type. Should be "password" per the OAuth2 spec.

username: String

The username (required).

password: String

The password (required).

scope: String

Space-separated scopes. Defaults to empty string.

client_id: Option<String>

Optional client ID.

client_secret: Option<String>

Optional client secret.

Implementations

impl OAuth2PasswordRequestForm

pub fn scopes(&self) -> Vec<String>

Parse the scope field into a vector of individual scope strings.

Trait Implementations

impl Clone for OAuth2PasswordRequestForm

fn clone(&self) -> OAuth2PasswordRequestForm

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OAuth2PasswordRequestForm

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromRequest for OAuth2PasswordRequestForm

type Error = OAuth2PasswordFormError

Error type when extraction fails.

async fn from_request( ctx: &RequestContext, req: &mut Request, ) -> Result<Self, Self::Error>

Extract a value from the request.