Struct aws_sdk_ssooidc::operation::create_token::builders::CreateTokenFluentBuilder

pub struct CreateTokenFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateToken.

Creates and returns access and refresh tokens for clients that are authenticated using client secrets. The access token can be used to fetch short-term credentials for the assigned AWS accounts or to access application APIs using bearer authentication.

Implementations

impl CreateTokenFluentBuilder

pub fn as_input(&self) -> &CreateTokenInputBuilder

Access the CreateToken as a reference.

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

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 customize( self, ) -> CustomizableOperation<CreateTokenOutput, CreateTokenError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.

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

The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.

pub fn get_client_id(&self) -> &Option<String>

The unique identifier string for the client or application. This value comes from the 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 get_client_secret(&self) -> &Option<String>

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

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 get_grant_type(&self) -> &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.

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

pub fn get_device_code(&self) -> &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.

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

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

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 get_code(&self) -> &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.

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

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

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 get_refresh_token(&self) -> &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.

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

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

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.

pub fn get_scope(&self) -> &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.

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

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.

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

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.

pub fn get_redirect_uri(&self) -> &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.

Trait Implementations

impl Clone for CreateTokenFluentBuilder

fn clone(&self) -> CreateTokenFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateTokenFluentBuilder

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

Formats the value using the given formatter.