Struct rusoto_cognito_idp::UpdateUserPoolClientRequest

pub struct UpdateUserPoolClientRequest {
    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 explicit_auth_flows: Option<Vec<String>>,
    pub logout_ur_ls: Option<Vec<String>>,
    pub read_attributes: Option<Vec<String>>,
    pub refresh_token_validity: Option<i64>,
    pub supported_identity_providers: Option<Vec<String>>,
    pub user_pool_id: String,
    pub write_attributes: Option<Vec<String>>,
}

Represents the request to update the user pool client.

Fields

allowed_o_auth_flows: Option<Vec<String>>

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 token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

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

A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".

analytics_configuration: Option<AnalyticsConfigurationType>

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

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 use HTTP without TLS (i.e. use HTTPS instead of HTTP).

• Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

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 use HTTP without TLS (i.e. use HTTPS instead of HTTP).

• Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

explicit_auth_flows: Option<Vec<String>>

Explicit authentication flows.

logout_ur_ls: Option<Vec<String>>

A list of allowed logout URLs for the identity providers.

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

fn clone(&self) -> UpdateUserPoolClientRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

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 Debug for UpdateUserPoolClientRequest

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

Formats the value using the given formatter.

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.