Struct aws_sdk_ssooidc::operation::create_token_with_iam::CreateTokenWithIamOutput

#[non_exhaustive]
pub struct CreateTokenWithIamOutput {
    pub access_token: Option<String>,
    pub token_type: Option<String>,
    pub expires_in: i32,
    pub refresh_token: Option<String>,
    pub id_token: Option<String>,
    pub issued_token_type: Option<String>,
    pub scope: Option<Vec<String>>,
    /* private fields */
}

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

A bearer token to access AWS accounts and applications assigned to a user.

token_type: Option<String>

Used to notify the requester that the returned token is an access token. The supported token type is Bearer.

expires_in: i32

Indicates the time in seconds when an access token will expire.

refresh_token: Option<String>

A token that, if present, can be used to refresh a previously issued access token that might have expired.

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.

id_token: Option<String>

A JSON Web Token (JWT) that identifies the user associated with the issued access token.

issued_token_type: Option<String>

Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:

* Access Token - urn:ietf:params:oauth:token-type:access_token

* Refresh Token - urn:ietf:params:oauth:token-type:refresh_token

scope: Option<Vec<String>>

The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.

Implementations

impl CreateTokenWithIamOutput

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

A bearer token to access AWS accounts and applications assigned to a user.

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

Used to notify the requester that the returned token is an access token. The supported token type is Bearer.

pub fn expires_in(&self) -> i32

Indicates the time in seconds when an access token will expire.

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

A token that, if present, can be used to refresh a previously issued access token that might have expired.

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 id_token(&self) -> Option<&str>

A JSON Web Token (JWT) that identifies the user associated with the issued access token.

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

Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:

* Access Token - urn:ietf:params:oauth:token-type:access_token

* Refresh Token - urn:ietf:params:oauth:token-type:refresh_token

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

The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.

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().

impl CreateTokenWithIamOutput

pub fn builder() -> CreateTokenWithIamOutputBuilder

Creates a new builder-style object to manufacture CreateTokenWithIamOutput.

Trait Implementations

impl Clone for CreateTokenWithIamOutput

fn clone(&self) -> CreateTokenWithIamOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateTokenWithIamOutput

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

Formats the value using the given formatter.

impl PartialEq for CreateTokenWithIamOutput

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

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for CreateTokenWithIamOutput