/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the cognito-idp-2016-04-18.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.CognitoIdentityProvider.Model
{
///
/// Container for the parameters to the AdminDisableProviderForUser operation.
/// 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.
///
///
///
/// 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 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.
///
///
public partial class AdminDisableProviderForUserRequest : AmazonCognitoIdentityProviderRequest
{
private ProviderUserIdentifierType _user;
private string _userPoolId;
///
/// Gets and sets the property User.
///
/// The user to be disabled.
///
///
[AWSProperty(Required=true)]
public ProviderUserIdentifierType User
{
get { return this._user; }
set { this._user = value; }
}
// Check to see if User property is set
internal bool IsSetUser()
{
return this._user != null;
}
///
/// Gets and sets the property UserPoolId.
///
/// The user pool ID for the user pool.
///
///
[AWSProperty(Required=true)]
public string UserPoolId
{
get { return this._userPoolId; }
set { this._userPoolId = value; }
}
// Check to see if UserPoolId property is set
internal bool IsSetUserPoolId()
{
return this._userPoolId != null;
}
}
}