Struct aws_sdk_ssooidc::client::fluent_builders::CreateToken

pub struct CreateToken { /* private fields */ }

Fluent builder constructing a request to CreateToken.

Creates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the Amazon Web Services account.

Implementations

impl CreateToken

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateToken, AwsResponseRetryClassifier>, SdkError<CreateTokenError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(self) -> Result<CreateTokenOutput, SdkError<CreateTokenError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn client_id(self, input: impl Into<String>) -> Self

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

pub fn set_client_id(self, input: Option<String>) -> Self

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

pub fn client_secret(self, input: impl Into<String>) -> Self

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

pub fn set_client_secret(self, input: Option<String>) -> Self

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

pub fn grant_type(self, input: impl Into<String>) -> Self

Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:

urn:ietf:params:oauth:grant-type:device_code

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

pub fn set_grant_type(self, input: Option<String>) -> Self

Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:

urn:ietf:params:oauth:grant-type:device_code

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

pub fn device_code(self, input: impl Into<String>) -> Self

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 set_device_code(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

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 set_code(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

Currently, refreshToken is not yet implemented and is not supported. For more information about the features and limitations of the current Amazon Web Services SSO OIDC implementation, see Considerations for Using this Guide in the Amazon Web Services SSO OIDC API Reference.

The token used to obtain an access token in the event that the access token is invalid or expired.

pub fn set_refresh_token(self, input: Option<String>) -> Self

Currently, refreshToken is not yet implemented and is not supported. For more information about the features and limitations of the current Amazon Web Services SSO OIDC implementation, see Considerations for Using this Guide in the Amazon Web Services SSO OIDC API Reference.

The token used to obtain an access token in the event that the access token is invalid or expired.

pub fn scope(self, input: impl Into<String>) -> Self

Appends an item to scope.

To override the contents of this collection use set_scope.

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 set_scope(self, input: Option<Vec<String>>) -> Self

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, input: impl Into<String>) -> Self

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

pub fn set_redirect_uri(self, input: Option<String>) -> Self

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 CreateToken

fn clone(&self) -> CreateToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateToken

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

Formats the value using the given formatter.