Struct rusoto_cognito_idp::UpdateUserPoolClientRequest

pub struct UpdateUserPoolClientRequest {

    pub access_token_validity: Option<i64>,
    pub allowed_o_auth_flows: Option<Vec<String>>,
    pub allowed_o_auth_flows_user_pool_client: Option<bool>,
    pub allowed_o_auth_scopes: Option<Vec<String>>,
    pub analytics_configuration: Option<AnalyticsConfigurationType>,
    pub callback_ur_ls: Option<Vec<String>>,
    pub client_id: String,
    pub client_name: Option<String>,
    pub default_redirect_uri: Option<String>,
    pub enable_token_revocation: Option<bool>,
    pub explicit_auth_flows: Option<Vec<String>>,
    pub id_token_validity: Option<i64>,
    pub logout_ur_ls: Option<Vec<String>>,
    pub prevent_user_existence_errors: Option<String>,
    pub read_attributes: Option<Vec<String>>,
    pub refresh_token_validity: Option<i64>,
    pub supported_identity_providers: Option<Vec<String>>,
    pub token_validity_units: Option<TokenValidityUnitsType>,
    pub user_pool_id: String,
    pub write_attributes: Option<Vec<String>>,
}

Represents the request to update the user pool client.

Fields

access_token_validity: Option<i64>

The time limit, after which the access token is no longer valid and cannot be used.

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.

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.

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.

enable_token_revocation: Option<bool>

Enables or disables token revocation. For more information about revoking tokens, see RevokeToken.

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 flow ADMINUSERPASSWORDAUTH. This setting replaces the ADMINNOSRPAUTH 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.

id_token_validity: Option<i64>

The time limit, after which the ID token is no longer valid and cannot be used.

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.

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.

token_validity_units: Option<TokenValidityUnitsType>

The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.

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

fn clone(&self) -> UpdateUserPoolClientRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateUserPoolClientRequest

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

Formats the value using the given formatter.

impl Default for UpdateUserPoolClientRequest

fn default() -> UpdateUserPoolClientRequest

Returns the “default value” for a type.

impl PartialEq<UpdateUserPoolClientRequest> for UpdateUserPoolClientRequest

fn eq(&self, other: &UpdateUserPoolClientRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UpdateUserPoolClientRequest) -> bool

This method tests for !=.

impl Serialize for UpdateUserPoolClientRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UpdateUserPoolClientRequest