Struct aws_sdk_cognitoidentityprovider::operation::admin_disable_provider_for_user::builders::AdminDisableProviderForUserFluentBuilder

pub struct AdminDisableProviderForUserFluentBuilder { /* private fields */ }

Fluent builder constructing a request to AdminDisableProviderForUser.

Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser.

The ProviderName must match the value specified when creating an IdP for the pool.

To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user.

The ProviderAttributeName must always be Cognito_Subject for social IdPs. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.

For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Implementations

impl AdminDisableProviderForUserFluentBuilder

pub fn as_input(&self) -> &AdminDisableProviderForUserInputBuilder

Access the AdminDisableProviderForUser as a reference.

pub async fn send( self, ) -> Result<AdminDisableProviderForUserOutput, SdkError<AdminDisableProviderForUserError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<AdminDisableProviderForUserOutput, AdminDisableProviderForUserError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn user_pool_id(self, input: impl Into<String>) -> Self

The user pool ID for the user pool.

pub fn set_user_pool_id(self, input: Option<String>) -> Self

The user pool ID for the user pool.

pub fn get_user_pool_id(&self) -> &Option<String>

The user pool ID for the user pool.

pub fn user(self, input: ProviderUserIdentifierType) -> Self

The user to be disabled.

pub fn set_user(self, input: Option<ProviderUserIdentifierType>) -> Self

The user to be disabled.

pub fn get_user(&self) -> &Option<ProviderUserIdentifierType>

The user to be disabled.

Trait Implementations

impl Clone for AdminDisableProviderForUserFluentBuilder

fn clone(&self) -> AdminDisableProviderForUserFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdminDisableProviderForUserFluentBuilder

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

Formats the value using the given formatter.