Struct aws_sdk_ssooidc::operation::create_token::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 the client or application. This value comes from the 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 the following OAuth grant types: Device Code and Refresh Token. Specify either of the following values, depending on the grant type that you want:

* Device Code - urn:ietf:params:oauth:grant-type:device_code

* Refresh Token - refresh_token

For information about how to obtain the device code, see the StartDeviceAuthorization topic.

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 authorization request. This comes from the result of the StartDeviceAuthorization API.

code: Option<String>

Used only when calling this API for the Authorization Code grant type. The short-term code is used to identify this authorization request. This grant type is currently unsupported for the CreateToken API.

refresh_token: Option<String>

Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term tokens, such as the access token, that might expire.

For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.

scope: Option<Vec<String>>

The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.

redirect_uri: Option<String>

Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.

Implementations

impl CreateTokenInput

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

The unique identifier string for the client or application. This value comes from the 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 the following OAuth grant types: Device Code and Refresh Token. Specify either of the following values, depending on the grant type that you want:

* Device Code - urn:ietf:params:oauth:grant-type:device_code

* Refresh Token - refresh_token

For information about how to obtain the device code, see the StartDeviceAuthorization topic.

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 authorization request. This comes from the result of the StartDeviceAuthorization API.

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

Used only when calling this API for the Authorization Code grant type. The short-term code is used to identify this authorization request. This grant type is currently unsupported for the CreateToken API.

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

Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term tokens, such as the access token, that might expire.

For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.

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

The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .scope.is_none().

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

Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.

impl CreateTokenInput

pub fn builder() -> CreateTokenInputBuilder

Creates a new builder-style object to manufacture CreateTokenInput.

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 for CreateTokenInput

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