Struct aws_sdk_ssooidc::input::CreateTokenInput

#[non_exhaustive]
pub struct CreateTokenInput {
    pub client_id: Option<String>,
    pub client_secret: Option<String>,
    pub grant_type: Option<String>,
    pub device_code: Option<String>,
    pub code: Option<String>,
    pub refresh_token: Option<String>,
    pub scope: Option<Vec<String>>,
    pub redirect_uri: Option<String>,
}

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: Option<String>

The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.

client_secret: Option<String>

A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

grant_type: Option<String>

Supports grant types for authorization code, refresh token, and device code request.

device_code: Option<String>

Used only when calling this API for the device code grant type. This short-term code is used to identify this authentication attempt. This should come from an in-memory reference to the result of the StartDeviceAuthorization API.

code: Option<String>

The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

refresh_token: Option<String>

The token used to obtain an access token in the event that the access token is invalid or expired. This token is not issued by the service.

scope: Option<Vec<String>>

The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

redirect_uri: Option<String>

The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

Implementations

impl CreateTokenInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<CreateToken, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateToken>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateTokenInput

impl CreateTokenInput

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

The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.

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

A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

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

Supports grant types for authorization code, refresh token, and device code request.

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

Used only when calling this API for the device code grant type. This short-term code is used to identify this authentication attempt. This should come from an in-memory reference to the result of the StartDeviceAuthorization API.

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

The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

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

The token used to obtain an access token in the event that the access token is invalid or expired. This token is not issued by the service.

pub fn scope(&self) -> Option<&[String]>

The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

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

The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

Trait Implementations

impl Clone for CreateTokenInput

fn clone(&self) -> CreateTokenInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateTokenInput

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

Formats the value using the given formatter.

impl PartialEq<CreateTokenInput> for CreateTokenInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for CreateTokenInput