com.amazonaws.services.cognitoidentityprovider.model

Class AdminDisableProviderForUserRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminDisableProviderForUserRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AdminDisableProviderForUserRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminDisableProviderForUserRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
ProviderUserIdentifierType	getUser() The user to be disabled.
java.lang.String	getUserPoolId() The user pool ID for the user pool.
int	hashCode()
void	setUser(ProviderUserIdentifierType user) The user to be disabled.
void	setUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
AdminDisableProviderForUserRequest	withUser(ProviderUserIdentifierType user) The user to be disabled.
AdminDisableProviderForUserRequest	withUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdminDisableProviderForUserRequest

public AdminDisableProviderForUserRequest()

Method Detail

getUserPoolId

public java.lang.String getUserPoolId()

The user pool ID for the user pool.

Constraints:
Length: 0 - 131072

Returns:

The user pool ID for the user pool.

setUserPoolId

public void setUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool.

Constraints:
Length: 0 - 131072

Parameters:

userPoolId -

The user pool ID for the user pool.

withUserPoolId

public AdminDisableProviderForUserRequest withUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 131072

Parameters:

userPoolId -

The user pool ID for the user pool.

Returns:

A reference to this updated object so that method calls can be chained together.

getUser

public ProviderUserIdentifierType getUser()

The user to be disabled.

Returns:

The user to be disabled.

setUser

public void setUser(ProviderUserIdentifierType user)

The user to be disabled.

Parameters:

user -

The user to be disabled.

withUser

public AdminDisableProviderForUserRequest withUser(ProviderUserIdentifierType user)

The user to be disabled.

Returns a reference to this object so that method calls can be chained together.

Parameters:

user -

The user to be disabled.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object