1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateTokenInput {
/// <p>The unique identifier string for each client. This value should come from the persisted result of the <code>RegisterClient</code> API.</p>
#[doc(hidden)]
pub client_id: ::std::option::Option<::std::string::String>,
/// <p>A secret string generated for the client. This value should come from the persisted result of the <code>RegisterClient</code> API.</p>
#[doc(hidden)]
pub client_secret: ::std::option::Option<::std::string::String>,
/// <p>Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:</p>
/// <p> <code>urn:ietf:params:oauth:grant-type:<i>device_code</i> </code> </p>
/// <p>For information about how to obtain the device code, see the <code>StartDeviceAuthorization</code> topic.</p>
#[doc(hidden)]
pub grant_type: ::std::option::Option<::std::string::String>,
/// <p>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 <code>StartDeviceAuthorization</code> API.</p>
#[doc(hidden)]
pub device_code: ::std::option::Option<::std::string::String>,
/// <p>The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.</p>
#[doc(hidden)]
pub code: ::std::option::Option<::std::string::String>,
/// <p>Currently, <code>refreshToken</code> is not yet implemented and is not supported. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center OIDC API Reference</a>.</p>
/// <p>The token used to obtain an access token in the event that the access token is invalid or expired.</p>
#[doc(hidden)]
pub refresh_token: ::std::option::Option<::std::string::String>,
/// <p>The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.</p>
#[doc(hidden)]
pub scope: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.</p>
#[doc(hidden)]
pub redirect_uri: ::std::option::Option<::std::string::String>,
}
impl CreateTokenInput {
/// <p>The unique identifier string for each client. This value should come from the persisted result of the <code>RegisterClient</code> API.</p>
pub fn client_id(&self) -> ::std::option::Option<&str> {
self.client_id.as_deref()
}
/// <p>A secret string generated for the client. This value should come from the persisted result of the <code>RegisterClient</code> API.</p>
pub fn client_secret(&self) -> ::std::option::Option<&str> {
self.client_secret.as_deref()
}
/// <p>Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:</p>
/// <p> <code>urn:ietf:params:oauth:grant-type:<i>device_code</i> </code> </p>
/// <p>For information about how to obtain the device code, see the <code>StartDeviceAuthorization</code> topic.</p>
pub fn grant_type(&self) -> ::std::option::Option<&str> {
self.grant_type.as_deref()
}
/// <p>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 <code>StartDeviceAuthorization</code> API.</p>
pub fn device_code(&self) -> ::std::option::Option<&str> {
self.device_code.as_deref()
}
/// <p>The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.</p>
pub fn code(&self) -> ::std::option::Option<&str> {
self.code.as_deref()
}
/// <p>Currently, <code>refreshToken</code> is not yet implemented and is not supported. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center OIDC API Reference</a>.</p>
/// <p>The token used to obtain an access token in the event that the access token is invalid or expired.</p>
pub fn refresh_token(&self) -> ::std::option::Option<&str> {
self.refresh_token.as_deref()
}
/// <p>The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.</p>
pub fn scope(&self) -> ::std::option::Option<&[::std::string::String]> {
self.scope.as_deref()
}
/// <p>The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.</p>
pub fn redirect_uri(&self) -> ::std::option::Option<&str> {
self.redirect_uri.as_deref()
}
}
impl CreateTokenInput {
/// Creates a new builder-style object to manufacture [`CreateTokenInput`](crate::operation::create_token::CreateTokenInput).
pub fn builder() -> crate::operation::create_token::builders::CreateTokenInputBuilder {
crate::operation::create_token::builders::CreateTokenInputBuilder::default()
}
}
/// A builder for [`CreateTokenInput`](crate::operation::create_token::CreateTokenInput).
#[non_exhaustive]
#[derive(
::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug,
)]
pub struct CreateTokenInputBuilder {
pub(crate) client_id: ::std::option::Option<::std::string::String>,
pub(crate) client_secret: ::std::option::Option<::std::string::String>,
pub(crate) grant_type: ::std::option::Option<::std::string::String>,
pub(crate) device_code: ::std::option::Option<::std::string::String>,
pub(crate) code: ::std::option::Option<::std::string::String>,
pub(crate) refresh_token: ::std::option::Option<::std::string::String>,
pub(crate) scope: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) redirect_uri: ::std::option::Option<::std::string::String>,
}
impl CreateTokenInputBuilder {
/// <p>The unique identifier string for each client. This value should come from the persisted result of the <code>RegisterClient</code> API.</p>
pub fn client_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.client_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The unique identifier string for each client. This value should come from the persisted result of the <code>RegisterClient</code> API.</p>
pub fn set_client_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.client_id = input;
self
}
/// <p>A secret string generated for the client. This value should come from the persisted result of the <code>RegisterClient</code> API.</p>
pub fn client_secret(
mut self,
input: impl ::std::convert::Into<::std::string::String>,
) -> Self {
self.client_secret = ::std::option::Option::Some(input.into());
self
}
/// <p>A secret string generated for the client. This value should come from the persisted result of the <code>RegisterClient</code> API.</p>
pub fn set_client_secret(
mut self,
input: ::std::option::Option<::std::string::String>,
) -> Self {
self.client_secret = input;
self
}
/// <p>Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:</p>
/// <p> <code>urn:ietf:params:oauth:grant-type:<i>device_code</i> </code> </p>
/// <p>For information about how to obtain the device code, see the <code>StartDeviceAuthorization</code> topic.</p>
pub fn grant_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.grant_type = ::std::option::Option::Some(input.into());
self
}
/// <p>Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:</p>
/// <p> <code>urn:ietf:params:oauth:grant-type:<i>device_code</i> </code> </p>
/// <p>For information about how to obtain the device code, see the <code>StartDeviceAuthorization</code> topic.</p>
pub fn set_grant_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.grant_type = input;
self
}
/// <p>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 <code>StartDeviceAuthorization</code> API.</p>
pub fn device_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.device_code = ::std::option::Option::Some(input.into());
self
}
/// <p>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 <code>StartDeviceAuthorization</code> API.</p>
pub fn set_device_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.device_code = input;
self
}
/// <p>The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.</p>
pub fn code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.code = ::std::option::Option::Some(input.into());
self
}
/// <p>The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.</p>
pub fn set_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.code = input;
self
}
/// <p>Currently, <code>refreshToken</code> is not yet implemented and is not supported. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center OIDC API Reference</a>.</p>
/// <p>The token used to obtain an access token in the event that the access token is invalid or expired.</p>
pub fn refresh_token(
mut self,
input: impl ::std::convert::Into<::std::string::String>,
) -> Self {
self.refresh_token = ::std::option::Option::Some(input.into());
self
}
/// <p>Currently, <code>refreshToken</code> is not yet implemented and is not supported. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center OIDC API Reference</a>.</p>
/// <p>The token used to obtain an access token in the event that the access token is invalid or expired.</p>
pub fn set_refresh_token(
mut self,
input: ::std::option::Option<::std::string::String>,
) -> Self {
self.refresh_token = input;
self
}
/// Appends an item to `scope`.
///
/// To override the contents of this collection use [`set_scope`](Self::set_scope).
///
/// <p>The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.</p>
pub fn scope(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.scope.unwrap_or_default();
v.push(input.into());
self.scope = ::std::option::Option::Some(v);
self
}
/// <p>The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.</p>
pub fn set_scope(
mut self,
input: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
) -> Self {
self.scope = input;
self
}
/// <p>The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.</p>
pub fn redirect_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.redirect_uri = ::std::option::Option::Some(input.into());
self
}
/// <p>The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.</p>
pub fn set_redirect_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.redirect_uri = input;
self
}
/// Consumes the builder and constructs a [`CreateTokenInput`](crate::operation::create_token::CreateTokenInput).
pub fn build(
self,
) -> ::std::result::Result<
crate::operation::create_token::CreateTokenInput,
::aws_smithy_http::operation::error::BuildError,
> {
::std::result::Result::Ok(crate::operation::create_token::CreateTokenInput {
client_id: self.client_id,
client_secret: self.client_secret,
grant_type: self.grant_type,
device_code: self.device_code,
code: self.code,
refresh_token: self.refresh_token,
scope: self.scope,
redirect_uri: self.redirect_uri,
})
}
}