[−][src]Struct rusoto_cognito_idp::UpdateUserPoolClientRequest
Represents the request to update the user pool client.
Fields
allowed_o_auth_flows: Option<Vec<String>>
The allowed OAuth flows.
Set to code
to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
Set to implicit
to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
Set to client_credentials
to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
allowed_o_auth_flows_user_pool_client: Option<bool>
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
allowed_o_auth_scopes: Option<Vec<String>>
The allowed OAuth scopes. Possible values provided by OAuth are: phone
, email
, openid
, and profile
. Possible values provided by AWS are: aws.cognito.signin.user.admin
. Custom scopes created in Resource Servers are also supported.
analytics_configuration: Option<AnalyticsConfigurationType>
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
callback_ur_ls: Option<Vec<String>>
A list of allowed redirect (callback) URLs for the identity providers.
A redirect URI must:
-
Be an absolute URI.
-
Be registered with the authorization server.
-
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
client_id: String
The ID of the client associated with the user pool.
client_name: Option<String>
The client name from the update user pool client request.
default_redirect_uri: Option<String>
The default redirect URI. Must be in the CallbackURLs
list.
A redirect URI must:
-
Be an absolute URI.
-
Be registered with the authorization server.
-
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
explicit_auth_flows: Option<Vec<String>>
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW
prefix are deprecated in favor of new names with the ALLOW
prefix. Note that values with ALLOW
prefix cannot be used along with values without ALLOW
prefix.
Valid values include:
-
ALLOWADMINUSERPASSWORDAUTH
: Enable admin based user password authentication flowADMINUSERPASSWORDAUTH
. This setting replaces theADMINNOSRPAUTH
setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords. -
ALLOWCUSTOMAUTH
: Enable Lambda trigger based authentication. -
ALLOWUSERPASSWORDAUTH
: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords. -
ALLOWUSERSRPAUTH
: Enable SRP based authentication. -
ALLOWREFRESHTOKEN_AUTH
: Enable authflow to refresh tokens.
logout_ur_ls: Option<Vec<String>>
A list of allowed logout URLs for the identity providers.
prevent_user_existence_errors: Option<String>
Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED
and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY
, those APIs will return a UserNotFoundException
exception if the user does not exist in the user pool.
Valid values include:
-
ENABLED
- This prevents user existence-related errors. -
LEGACY
- This represents the old behavior of Cognito where user existence related errors are not prevented.
This setting affects the behavior of following APIs:
After February 15th 2020, the value of PreventUserExistenceErrors
will default to ENABLED
for newly created user pool clients if no value is provided.
read_attributes: Option<Vec<String>>
The read-only attributes of the user pool.
refresh_token_validity: Option<i64>
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
supported_identity_providers: Option<Vec<String>>
A list of provider names for the identity providers that are supported on this client.
user_pool_id: String
The user pool ID for the user pool where you want to update the user pool client.
write_attributes: Option<Vec<String>>
The writeable attributes of the user pool.
Trait Implementations
impl Clone for UpdateUserPoolClientRequest
[src]
pub fn clone(&self) -> UpdateUserPoolClientRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for UpdateUserPoolClientRequest
[src]
impl Default for UpdateUserPoolClientRequest
[src]
pub fn default() -> UpdateUserPoolClientRequest
[src]
impl PartialEq<UpdateUserPoolClientRequest> for UpdateUserPoolClientRequest
[src]
pub fn eq(&self, other: &UpdateUserPoolClientRequest) -> bool
[src]
pub fn ne(&self, other: &UpdateUserPoolClientRequest) -> bool
[src]
impl Serialize for UpdateUserPoolClientRequest
[src]
pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralPartialEq for UpdateUserPoolClientRequest
[src]
Auto Trait Implementations
impl RefUnwindSafe for UpdateUserPoolClientRequest
[src]
impl Send for UpdateUserPoolClientRequest
[src]
impl Sync for UpdateUserPoolClientRequest
[src]
impl Unpin for UpdateUserPoolClientRequest
[src]
impl UnwindSafe for UpdateUserPoolClientRequest
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,