/******************************************************************************* * Copyright 2012-2019 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. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.CognitoIdentityProvider; using Amazon.CognitoIdentityProvider.Model; namespace Amazon.PowerShell.Cmdlets.CGIP { /// /// 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. /// /// [Cmdlet("Disable", "CGIPProviderForUserAdmin", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the Amazon Cognito Identity Provider AdminDisableProviderForUser API operation.", Operation = new[] {"AdminDisableProviderForUser"}, SelectReturnType = typeof(Amazon.CognitoIdentityProvider.Model.AdminDisableProviderForUserResponse))] [AWSCmdletOutput("None or Amazon.CognitoIdentityProvider.Model.AdminDisableProviderForUserResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.CognitoIdentityProvider.Model.AdminDisableProviderForUserResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class DisableCGIPProviderForUserAdminCmdlet : AmazonCognitoIdentityProviderClientCmdlet, IExecutor { #region Parameter User_ProviderAttributeName /// /// /// The name of the provider attribute to link to, such as NameID. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String User_ProviderAttributeName { get; set; } #endregion #region Parameter User_ProviderAttributeValue /// /// /// The value of the provider attribute to link to, such as xxxxx_account. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String User_ProviderAttributeValue { get; set; } #endregion #region Parameter User_ProviderName /// /// /// The name of the provider, such as Facebook, Google, or Login with Amazon. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String User_ProviderName { get; set; } #endregion #region Parameter UserPoolId /// /// /// The user pool ID for the user pool. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] #else [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String UserPoolId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentityProvider.Model.AdminDisableProviderForUserResponse). /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the UserPoolId parameter. /// The -PassThru parameter is deprecated, use -Select '^UserPoolId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^UserPoolId' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter Force /// /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter Force { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.UserPoolId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Disable-CGIPProviderForUserAdmin (AdminDisableProviderForUser)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); if (this.PassThru.IsPresent) { throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select)); } } else if (this.PassThru.IsPresent) { context.Select = (response, cmdlet) => this.UserPoolId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.User_ProviderAttributeName = this.User_ProviderAttributeName; context.User_ProviderAttributeValue = this.User_ProviderAttributeValue; context.User_ProviderName = this.User_ProviderName; context.UserPoolId = this.UserPoolId; #if MODULAR if (this.UserPoolId == null && ParameterWasBound(nameof(this.UserPoolId))) { WriteWarning("You are passing $null as a value for parameter UserPoolId which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.CognitoIdentityProvider.Model.AdminDisableProviderForUserRequest(); // populate User var requestUserIsNull = true; request.User = new Amazon.CognitoIdentityProvider.Model.ProviderUserIdentifierType(); System.String requestUser_user_ProviderAttributeName = null; if (cmdletContext.User_ProviderAttributeName != null) { requestUser_user_ProviderAttributeName = cmdletContext.User_ProviderAttributeName; } if (requestUser_user_ProviderAttributeName != null) { request.User.ProviderAttributeName = requestUser_user_ProviderAttributeName; requestUserIsNull = false; } System.String requestUser_user_ProviderAttributeValue = null; if (cmdletContext.User_ProviderAttributeValue != null) { requestUser_user_ProviderAttributeValue = cmdletContext.User_ProviderAttributeValue; } if (requestUser_user_ProviderAttributeValue != null) { request.User.ProviderAttributeValue = requestUser_user_ProviderAttributeValue; requestUserIsNull = false; } System.String requestUser_user_ProviderName = null; if (cmdletContext.User_ProviderName != null) { requestUser_user_ProviderName = cmdletContext.User_ProviderName; } if (requestUser_user_ProviderName != null) { request.User.ProviderName = requestUser_user_ProviderName; requestUserIsNull = false; } // determine if request.User should be set to null if (requestUserIsNull) { request.User = null; } if (cmdletContext.UserPoolId != null) { request.UserPoolId = cmdletContext.UserPoolId; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.CognitoIdentityProvider.Model.AdminDisableProviderForUserResponse CallAWSServiceOperation(IAmazonCognitoIdentityProvider client, Amazon.CognitoIdentityProvider.Model.AdminDisableProviderForUserRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Cognito Identity Provider", "AdminDisableProviderForUser"); try { #if DESKTOP return client.AdminDisableProviderForUser(request); #elif CORECLR return client.AdminDisableProviderForUserAsync(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public System.String User_ProviderAttributeName { get; set; } public System.String User_ProviderAttributeValue { get; set; } public System.String User_ProviderName { get; set; } public System.String UserPoolId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }