Struct CreateOAuth2TokenRequestBody

#[non_exhaustive]
pub struct CreateOAuth2TokenRequestBody {
    pub client_id: String,
    pub grant_type: String,
    pub code: Option<String>,
    pub redirect_uri: Option<String>,
    pub code_verifier: Option<String>,
    pub refresh_token: Option<String>,
}

Request body payload for CreateOAuth2Token operation The operation type is determined by the grant_type parameter: - grant_type=authorization_code: Requires code, redirect_uri, code_verifier - grant_type=refresh_token: Requires refresh_token

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

client_id: String

The client identifier (ARN) used during Sign-In onboarding Required for both authorization code and refresh token flows

grant_type: String

OAuth 2.0 grant type - determines which flow is used Must be “authorization_code” or “refresh_token”

code: Option<String>

The authorization code received from /v1/authorize Required only when grant_type=authorization_code

redirect_uri: Option<String>

The redirect URI that must match the original authorization request Required only when grant_type=authorization_code

code_verifier: Option<String>

PKCE code verifier to prove possession of the original code challenge Required only when grant_type=authorization_code

refresh_token: Option<String>

The refresh token returned from auth_code redemption Required only when grant_type=refresh_token

Implementations

impl CreateOAuth2TokenRequestBody

pub fn client_id(&self) -> &str

The client identifier (ARN) used during Sign-In onboarding Required for both authorization code and refresh token flows

pub fn grant_type(&self) -> &str

OAuth 2.0 grant type - determines which flow is used Must be “authorization_code” or “refresh_token”

pub fn code(&self) -> Option<&str>

The authorization code received from /v1/authorize Required only when grant_type=authorization_code

pub fn redirect_uri(&self) -> Option<&str>

The redirect URI that must match the original authorization request Required only when grant_type=authorization_code

pub fn code_verifier(&self) -> Option<&str>

PKCE code verifier to prove possession of the original code challenge Required only when grant_type=authorization_code

pub fn refresh_token(&self) -> Option<&str>

The refresh token returned from auth_code redemption Required only when grant_type=refresh_token

impl CreateOAuth2TokenRequestBody

pub fn builder() -> CreateOAuth2TokenRequestBodyBuilder

Creates a new builder-style object to manufacture CreateOAuth2TokenRequestBody.

Trait Implementations

impl Clone for CreateOAuth2TokenRequestBody

fn clone(&self) -> CreateOAuth2TokenRequestBody

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateOAuth2TokenRequestBody

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

Formats the value using the given formatter.

impl PartialEq for CreateOAuth2TokenRequestBody

fn eq(&self, other: &CreateOAuth2TokenRequestBody) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateOAuth2TokenRequestBody