aws_sdk_ssooidc::operation::create_token_with_iam

Struct CreateTokenWithIamOutput

Source
#[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)§

This struct is marked as 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§

Source§

impl CreateTokenWithIamOutput

Source

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

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

Source

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.

Source

pub fn expires_in(&self) -> i32

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

Source

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.

Source

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

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

Source

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

Source

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

Source§

impl CreateTokenWithIamOutput

Source

pub fn builder() -> CreateTokenWithIamOutputBuilder

Creates a new builder-style object to manufacture CreateTokenWithIamOutput.

Trait Implementations§

Source§

impl Clone for CreateTokenWithIamOutput

Source§

fn clone(&self) -> CreateTokenWithIamOutput

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CreateTokenWithIamOutput

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for CreateTokenWithIamOutput

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl RequestId for CreateTokenWithIamOutput

Source§

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

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

impl StructuralPartialEq for CreateTokenWithIamOutput

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more