com.amazonaws.services.cognitoidentityprovider.model

Class AdminDisableProviderForUserRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminDisableProviderForUserRequest

All Implemented Interfaces:

Serializable, Cloneable

public class AdminDisableProviderForUserRequest
extends AmazonWebServiceRequest
implements Serializable

Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. See .

This action is enabled only for admin access and requires developer credentials.

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

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

The ProviderAttributeName must always be Cognito_Subject for social identity providers. 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 in the 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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminDisableProviderForUserRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
ProviderUserIdentifierType	getUser() The user to be disabled.
String	getUserPoolId() The user pool ID for the user pool.
int	hashCode()
void	setUser(ProviderUserIdentifierType user) The user to be disabled.
void	setUserPoolId(String userPoolId) The user pool ID for the user pool.
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(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 String getUserPoolId()

The user pool ID for the user pool.

Returns:

The user pool ID for the user pool.

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID for the user pool.

Parameters:

userPoolId -

The user pool ID for the user pool.

withUserPoolId

public AdminDisableProviderForUserRequest withUserPoolId(String userPoolId)

The user pool ID for the user pool.

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

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 String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object