Struct CreateOAuth2TokenResponseBody

#[non_exhaustive]
pub struct CreateOAuth2TokenResponseBody {
    pub access_token: Option<AccessToken>,
    pub token_type: String,
    pub expires_in: i32,
    pub refresh_token: String,
    pub id_token: Option<String>,
}

Response body payload for CreateOAuth2Token operation The response content depends on the grant_type from the request: - grant_type=authorization_code: Returns all fields including refresh_token and id_token - grant_type=refresh_token: Returns access_token, token_type, expires_in, refresh_token (no id_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.

access_token: Option<AccessToken>

Scoped-down AWS credentials (15 minute duration) Present for both authorization code redemption and token refresh

token_type: String

Token type indicating this is AWS SigV4 credentials Value is “aws_sigv4” for both flows

expires_in: i32

Time to expiry in seconds (maximum 900) Present for both authorization code redemption and token refresh

refresh_token: String

Encrypted refresh token with cnf.jkt (SHA-256 thumbprint of presented jwk) Always present in responses (required for both flows)

id_token: Option<String>

ID token containing user identity information Present only in authorization code redemption response (grant_type=authorization_code) Not included in token refresh responses

Implementations

impl CreateOAuth2TokenResponseBody

pub fn access_token(&self) -> Option<&AccessToken>

Scoped-down AWS credentials (15 minute duration) Present for both authorization code redemption and token refresh

pub fn token_type(&self) -> &str

Token type indicating this is AWS SigV4 credentials Value is “aws_sigv4” for both flows

pub fn expires_in(&self) -> i32

Time to expiry in seconds (maximum 900) Present for both authorization code redemption and token refresh

pub fn refresh_token(&self) -> &str

Encrypted refresh token with cnf.jkt (SHA-256 thumbprint of presented jwk) Always present in responses (required for both flows)

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

ID token containing user identity information Present only in authorization code redemption response (grant_type=authorization_code) Not included in token refresh responses

impl CreateOAuth2TokenResponseBody

pub fn builder() -> CreateOAuth2TokenResponseBodyBuilder

Creates a new builder-style object to manufacture CreateOAuth2TokenResponseBody.

Trait Implementations

impl Clone for CreateOAuth2TokenResponseBody

fn clone(&self) -> CreateOAuth2TokenResponseBody

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateOAuth2TokenResponseBody

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

Formats the value using the given formatter.

impl PartialEq for CreateOAuth2TokenResponseBody

fn eq(&self, other: &CreateOAuth2TokenResponseBody) -> 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 CreateOAuth2TokenResponseBody