Struct aws_sdk_cognitoidentityprovider::model::UserPoolClientType

#[non_exhaustive]
pub struct UserPoolClientType {

    pub user_pool_id: Option<String>,
    pub client_name: Option<String>,
    pub client_id: Option<String>,
    pub client_secret: Option<String>,
    pub last_modified_date: Option<DateTime>,
    pub creation_date: Option<DateTime>,
    pub refresh_token_validity: i32,
    pub access_token_validity: Option<i32>,
    pub id_token_validity: Option<i32>,
    pub token_validity_units: Option<TokenValidityUnitsType>,
    pub read_attributes: Option<Vec<String>>,
    pub write_attributes: Option<Vec<String>>,
    pub explicit_auth_flows: Option<Vec<ExplicitAuthFlowsType>>,
    pub supported_identity_providers: Option<Vec<String>>,
    pub callback_ur_ls: Option<Vec<String>>,
    pub logout_ur_ls: Option<Vec<String>>,
    pub default_redirect_uri: Option<String>,
    pub allowed_o_auth_flows: Option<Vec<OAuthFlowType>>,
    pub allowed_o_auth_scopes: Option<Vec<String>>,
    pub allowed_o_auth_flows_user_pool_client: Option<bool>,
    pub analytics_configuration: Option<AnalyticsConfigurationType>,
    pub prevent_user_existence_errors: Option<PreventUserExistenceErrorTypes>,
    pub enable_token_revocation: Option<bool>,
}

Contains information about a user pool client.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_pool_id: Option<String>

The user pool ID for the user pool client.

client_name: Option<String>

The client name from the user pool request of the client type.

client_id: Option<String>

The ID of the client associated with the user pool.

client_secret: Option<String>

The client secret from the user pool request of the client type.

last_modified_date: Option<DateTime>

The date the user pool client was last modified.

creation_date: Option<DateTime>

The date the user pool client was created.

refresh_token_validity: i32

The time limit, in days, after which the refresh token is no longer valid and can't be used.

access_token_validity: Option<i32>

The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and can't be used.

id_token_validity: Option<i32>

The time limit specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and can't be used.

token_validity_units: Option<TokenValidityUnitsType>

The time units used to specify the token validity times of their respective token.

read_attributes: Option<Vec<String>>

The Read-only attributes.

write_attributes: Option<Vec<String>>

The writeable attributes.

explicit_auth_flows: Option<Vec<ExplicitAuthFlowsType>>

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the ALLOW_ prefix.

Valid values include:

• ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.

• ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

• ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

• ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.

• ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

supported_identity_providers: Option<Vec<String>>

A list of provider names for the identity providers that are supported on this 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.

logout_ur_ls: Option<Vec<String>>

A list of allowed logout URLs for the identity providers.

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.

allowed_o_auth_flows: Option<Vec<OAuthFlowType>>

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_scopes: Option<Vec<String>>

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

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 Amazon Cognito user pools.

analytics_configuration: Option<AnalyticsConfigurationType>

The Amazon Pinpoint analytics configuration for the user pool client.

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

prevent_user_existence_errors: Option<PreventUserExistenceErrorTypes>

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't 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 aren't prevented.

enable_token_revocation: Option<bool>

Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.

Implementations

impl UserPoolClientType

pub fn user_pool_id(&self) -> Option<&str>

The user pool ID for the user pool client.

pub fn client_name(&self) -> Option<&str>

The client name from the user pool request of the client type.

pub fn client_id(&self) -> Option<&str>

The ID of the client associated with the user pool.

pub fn client_secret(&self) -> Option<&str>

The client secret from the user pool request of the client type.

pub fn last_modified_date(&self) -> Option<&DateTime>

The date the user pool client was last modified.

pub fn creation_date(&self) -> Option<&DateTime>

The date the user pool client was created.

pub fn refresh_token_validity(&self) -> i32

The time limit, in days, after which the refresh token is no longer valid and can't be used.

pub fn access_token_validity(&self) -> Option<i32>

The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and can't be used.

pub fn id_token_validity(&self) -> Option<i32>

The time limit specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and can't be used.

pub fn token_validity_units(&self) -> Option<&TokenValidityUnitsType>

The time units used to specify the token validity times of their respective token.

pub fn read_attributes(&self) -> Option<&[String]>

The Read-only attributes.

pub fn write_attributes(&self) -> Option<&[String]>

The writeable attributes.

pub fn explicit_auth_flows(&self) -> Option<&[ExplicitAuthFlowsType]>

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the ALLOW_ prefix.

Valid values include:

• ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.

• ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

• ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

• ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.

• ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

pub fn supported_identity_providers(&self) -> Option<&[String]>

A list of provider names for the identity providers that are supported on this client.

pub fn callback_ur_ls(&self) -> Option<&[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.

pub fn logout_ur_ls(&self) -> Option<&[String]>

A list of allowed logout URLs for the identity providers.

pub fn default_redirect_uri(&self) -> Option<&str>

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.

pub fn allowed_o_auth_flows(&self) -> Option<&[OAuthFlowType]>

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.

pub fn allowed_o_auth_scopes(&self) -> Option<&[String]>

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

pub fn allowed_o_auth_flows_user_pool_client(&self) -> Option<bool>

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

pub fn analytics_configuration(&self) -> Option<&AnalyticsConfigurationType>

The Amazon Pinpoint analytics configuration for the user pool client.

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

pub fn prevent_user_existence_errors(
    &self
) -> Option<&PreventUserExistenceErrorTypes>

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't 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 aren't prevented.

pub fn enable_token_revocation(&self) -> Option<bool>

Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.

impl UserPoolClientType

pub fn builder() -> Builder

Creates a new builder-style object to manufacture UserPoolClientType

Trait Implementations

impl Clone for UserPoolClientType

fn clone(&self) -> UserPoolClientType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserPoolClientType

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

Formats the value using the given formatter.

impl PartialEq<UserPoolClientType> for UserPoolClientType

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

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

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

This method tests for !=.

impl StructuralPartialEq for UserPoolClientType