#[non_exhaustive]pub struct CreateTokenWithIamInputBuilder { /* private fields */ }
Expand description
A builder for CreateTokenWithIamInput
.
Implementations§
Source§impl CreateTokenWithIamInputBuilder
impl CreateTokenWithIamInputBuilder
Sourcepub fn client_id(self, input: impl Into<String>) -> Self
pub fn client_id(self, input: impl Into<String>) -> Self
The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.
This field is required.Sourcepub fn set_client_id(self, input: Option<String>) -> Self
pub fn set_client_id(self, input: Option<String>) -> Self
The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.
Sourcepub fn get_client_id(&self) -> &Option<String>
pub fn get_client_id(&self) -> &Option<String>
The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.
Sourcepub fn grant_type(self, input: impl Into<String>) -> Self
pub fn grant_type(self, input: impl Into<String>) -> Self
Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want:
* Authorization Code - authorization_code
* Refresh Token - refresh_token
* JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer
* Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange
Sourcepub fn set_grant_type(self, input: Option<String>) -> Self
pub fn set_grant_type(self, input: Option<String>) -> Self
Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want:
* Authorization Code - authorization_code
* Refresh Token - refresh_token
* JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer
* Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange
Sourcepub fn get_grant_type(&self) -> &Option<String>
pub fn get_grant_type(&self) -> &Option<String>
Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want:
* Authorization Code - authorization_code
* Refresh Token - refresh_token
* JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer
* Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange
Sourcepub fn code(self, input: impl Into<String>) -> Self
pub fn code(self, input: impl Into<String>) -> Self
Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.
Sourcepub fn set_code(self, input: Option<String>) -> Self
pub fn set_code(self, input: Option<String>) -> Self
Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.
Sourcepub fn get_code(&self) -> &Option<String>
pub fn get_code(&self) -> &Option<String>
Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.
Sourcepub fn refresh_token(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_refresh_token(self, input: Option<String>) -> Self
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.
Sourcepub fn get_refresh_token(&self) -> &Option<String>
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.
Sourcepub fn assertion(self, input: impl Into<String>) -> Self
pub fn assertion(self, input: impl Into<String>) -> Self
Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.
Sourcepub fn set_assertion(self, input: Option<String>) -> Self
pub fn set_assertion(self, input: Option<String>) -> Self
Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.
Sourcepub fn get_assertion(&self) -> &Option<String>
pub fn get_assertion(&self) -> &Option<String>
Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.
Sourcepub fn scope(self, input: impl Into<String>) -> Self
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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid
, aws
, sts:identity_context
.
Sourcepub fn set_scope(self, input: Option<Vec<String>>) -> Self
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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid
, aws
, sts:identity_context
.
Sourcepub fn get_scope(&self) -> &Option<Vec<String>>
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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid
, aws
, sts:identity_context
.
Sourcepub fn redirect_uri(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_redirect_uri(self, input: Option<String>) -> Self
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.
Sourcepub fn get_redirect_uri(&self) -> &Option<String>
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.
Sourcepub fn subject_token(self, input: impl Into<String>) -> Self
pub fn subject_token(self, input: impl Into<String>) -> Self
Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.
Sourcepub fn set_subject_token(self, input: Option<String>) -> Self
pub fn set_subject_token(self, input: Option<String>) -> Self
Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.
Sourcepub fn get_subject_token(&self) -> &Option<String>
pub fn get_subject_token(&self) -> &Option<String>
Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.
Sourcepub fn subject_token_type(self, input: impl Into<String>) -> Self
pub fn subject_token_type(self, input: impl Into<String>) -> Self
Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:
* Access Token - urn:ietf:params:oauth:token-type:access_token
Sourcepub fn set_subject_token_type(self, input: Option<String>) -> Self
pub fn set_subject_token_type(self, input: Option<String>) -> Self
Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:
* Access Token - urn:ietf:params:oauth:token-type:access_token
Sourcepub fn get_subject_token_type(&self) -> &Option<String>
pub fn get_subject_token_type(&self) -> &Option<String>
Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:
* Access Token - urn:ietf:params:oauth:token-type:access_token
Sourcepub fn requested_token_type(self, input: impl Into<String>) -> Self
pub fn requested_token_type(self, input: impl Into<String>) -> Self
Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. 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
Sourcepub fn set_requested_token_type(self, input: Option<String>) -> Self
pub fn set_requested_token_type(self, input: Option<String>) -> Self
Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. 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
Sourcepub fn get_requested_token_type(&self) -> &Option<String>
pub fn get_requested_token_type(&self) -> &Option<String>
Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. 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
Sourcepub fn build(self) -> Result<CreateTokenWithIamInput, BuildError>
pub fn build(self) -> Result<CreateTokenWithIamInput, BuildError>
Consumes the builder and constructs a CreateTokenWithIamInput
.
Source§impl CreateTokenWithIamInputBuilder
impl CreateTokenWithIamInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreateTokenWithIamOutput, SdkError<CreateTokenWithIAMError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreateTokenWithIamOutput, SdkError<CreateTokenWithIAMError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for CreateTokenWithIamInputBuilder
impl Clone for CreateTokenWithIamInputBuilder
Source§fn clone(&self) -> CreateTokenWithIamInputBuilder
fn clone(&self) -> CreateTokenWithIamInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for CreateTokenWithIamInputBuilder
impl Default for CreateTokenWithIamInputBuilder
Source§fn default() -> CreateTokenWithIamInputBuilder
fn default() -> CreateTokenWithIamInputBuilder
Source§impl PartialEq for CreateTokenWithIamInputBuilder
impl PartialEq for CreateTokenWithIamInputBuilder
Source§fn eq(&self, other: &CreateTokenWithIamInputBuilder) -> bool
fn eq(&self, other: &CreateTokenWithIamInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CreateTokenWithIamInputBuilder
Auto Trait Implementations§
impl Freeze for CreateTokenWithIamInputBuilder
impl RefUnwindSafe for CreateTokenWithIamInputBuilder
impl Send for CreateTokenWithIamInputBuilder
impl Sync for CreateTokenWithIamInputBuilder
impl Unpin for CreateTokenWithIamInputBuilder
impl UnwindSafe for CreateTokenWithIamInputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)