[−][src]Struct rusoto_cognito_idp::UserPoolClientType
Contains information about a 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"
. In addition to these values, custom scopes created in Resource Servers are also supported.
analytics_configuration: Option<AnalyticsConfigurationType>
The Amazon Pinpoint analytics configuration for the user pool client.
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: Option<String>
The ID of the client associated with the user pool.
client_name: Option<String>
The client name from the user pool request of the client type.
client_secret: Option<String>
The client secret from the user pool request of the client type.
creation_date: Option<f64>
The date the user pool client was created.
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.
last_modified_date: Option<f64>
The date the user pool client was last modified.
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 January 1st 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.
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: Option<String>
The user pool ID for the user pool client.
write_attributes: Option<Vec<String>>
The writeable attributes.
Trait Implementations
impl Clone for UserPoolClientType
[src]
fn clone(&self) -> UserPoolClientType
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for UserPoolClientType
[src]
impl Default for UserPoolClientType
[src]
fn default() -> UserPoolClientType
[src]
impl<'de> Deserialize<'de> for UserPoolClientType
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl PartialEq<UserPoolClientType> for UserPoolClientType
[src]
fn eq(&self, other: &UserPoolClientType) -> bool
[src]
fn ne(&self, other: &UserPoolClientType) -> bool
[src]
impl StructuralPartialEq for UserPoolClientType
[src]
Auto Trait Implementations
impl RefUnwindSafe for UserPoolClientType
impl Send for UserPoolClientType
impl Sync for UserPoolClientType
impl Unpin for UserPoolClientType
impl UnwindSafe for UserPoolClientType
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,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> From<T> for T
[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.
fn to_owned(&self) -> T
[src]
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.
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>,