/*******************************************************************************
* 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
{
///
/// Links an existing user account in a user pool (DestinationUser
) to an
/// identity from an external IdP (SourceUser
) based on a specified attribute
/// name and value from the external IdP. This allows you to create a link from the existing
/// user account to an external federated user identity that has not yet been used to
/// sign in. You can then use the federated user identity to sign in as the existing user
/// account.
///
///
///
/// For example, if there is an existing user with a username and password, this API
/// links that user to a federated user identity. When the user signs in with a federated
/// user identity, they sign in as the existing user account.
///
/// The maximum number of federated identities linked to a user is five.
///
/// Because this API allows a user with an external federated identity to sign in as an
/// existing user in the user pool, it is critical that it only be used with external
/// IdPs and provider attributes that have been trusted by the application owner.
///
/// This action is administrative and requires developer credentials.
///
///
[Cmdlet("Connect", "CGIPProviderForUserAdmin", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon Cognito Identity Provider AdminLinkProviderForUser API operation.", Operation = new[] {"AdminLinkProviderForUser"}, SelectReturnType = typeof(Amazon.CognitoIdentityProvider.Model.AdminLinkProviderForUserResponse))]
[AWSCmdletOutput("None or Amazon.CognitoIdentityProvider.Model.AdminLinkProviderForUserResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.CognitoIdentityProvider.Model.AdminLinkProviderForUserResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class ConnectCGIPProviderForUserAdminCmdlet : AmazonCognitoIdentityProviderClientCmdlet, IExecutor
{
#region Parameter DestinationUser_ProviderAttributeName
///
///
/// The name of the provider attribute to link to, such as NameID
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DestinationUser_ProviderAttributeName { get; set; }
#endregion
#region Parameter SourceUser_ProviderAttributeName
///
///
/// The name of the provider attribute to link to, such as NameID
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SourceUser_ProviderAttributeName { get; set; }
#endregion
#region Parameter DestinationUser_ProviderAttributeValue
///
///
/// The value of the provider attribute to link to, such as xxxxx_account
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DestinationUser_ProviderAttributeValue { get; set; }
#endregion
#region Parameter SourceUser_ProviderAttributeValue
///
///
/// The value of the provider attribute to link to, such as xxxxx_account
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SourceUser_ProviderAttributeValue { get; set; }
#endregion
#region Parameter DestinationUser_ProviderName
///
///
/// The name of the provider, such as Facebook, Google, or Login with Amazon.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DestinationUser_ProviderName { get; set; }
#endregion
#region Parameter SourceUser_ProviderName
///
///
/// The name of the provider, such as Facebook, Google, or Login with Amazon.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SourceUser_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.AdminLinkProviderForUserResponse).
/// 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, "Connect-CGIPProviderForUserAdmin (AdminLinkProviderForUser)"))
{
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.DestinationUser_ProviderAttributeName = this.DestinationUser_ProviderAttributeName;
context.DestinationUser_ProviderAttributeValue = this.DestinationUser_ProviderAttributeValue;
context.DestinationUser_ProviderName = this.DestinationUser_ProviderName;
context.SourceUser_ProviderAttributeName = this.SourceUser_ProviderAttributeName;
context.SourceUser_ProviderAttributeValue = this.SourceUser_ProviderAttributeValue;
context.SourceUser_ProviderName = this.SourceUser_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.AdminLinkProviderForUserRequest();
// populate DestinationUser
var requestDestinationUserIsNull = true;
request.DestinationUser = new Amazon.CognitoIdentityProvider.Model.ProviderUserIdentifierType();
System.String requestDestinationUser_destinationUser_ProviderAttributeName = null;
if (cmdletContext.DestinationUser_ProviderAttributeName != null)
{
requestDestinationUser_destinationUser_ProviderAttributeName = cmdletContext.DestinationUser_ProviderAttributeName;
}
if (requestDestinationUser_destinationUser_ProviderAttributeName != null)
{
request.DestinationUser.ProviderAttributeName = requestDestinationUser_destinationUser_ProviderAttributeName;
requestDestinationUserIsNull = false;
}
System.String requestDestinationUser_destinationUser_ProviderAttributeValue = null;
if (cmdletContext.DestinationUser_ProviderAttributeValue != null)
{
requestDestinationUser_destinationUser_ProviderAttributeValue = cmdletContext.DestinationUser_ProviderAttributeValue;
}
if (requestDestinationUser_destinationUser_ProviderAttributeValue != null)
{
request.DestinationUser.ProviderAttributeValue = requestDestinationUser_destinationUser_ProviderAttributeValue;
requestDestinationUserIsNull = false;
}
System.String requestDestinationUser_destinationUser_ProviderName = null;
if (cmdletContext.DestinationUser_ProviderName != null)
{
requestDestinationUser_destinationUser_ProviderName = cmdletContext.DestinationUser_ProviderName;
}
if (requestDestinationUser_destinationUser_ProviderName != null)
{
request.DestinationUser.ProviderName = requestDestinationUser_destinationUser_ProviderName;
requestDestinationUserIsNull = false;
}
// determine if request.DestinationUser should be set to null
if (requestDestinationUserIsNull)
{
request.DestinationUser = null;
}
// populate SourceUser
var requestSourceUserIsNull = true;
request.SourceUser = new Amazon.CognitoIdentityProvider.Model.ProviderUserIdentifierType();
System.String requestSourceUser_sourceUser_ProviderAttributeName = null;
if (cmdletContext.SourceUser_ProviderAttributeName != null)
{
requestSourceUser_sourceUser_ProviderAttributeName = cmdletContext.SourceUser_ProviderAttributeName;
}
if (requestSourceUser_sourceUser_ProviderAttributeName != null)
{
request.SourceUser.ProviderAttributeName = requestSourceUser_sourceUser_ProviderAttributeName;
requestSourceUserIsNull = false;
}
System.String requestSourceUser_sourceUser_ProviderAttributeValue = null;
if (cmdletContext.SourceUser_ProviderAttributeValue != null)
{
requestSourceUser_sourceUser_ProviderAttributeValue = cmdletContext.SourceUser_ProviderAttributeValue;
}
if (requestSourceUser_sourceUser_ProviderAttributeValue != null)
{
request.SourceUser.ProviderAttributeValue = requestSourceUser_sourceUser_ProviderAttributeValue;
requestSourceUserIsNull = false;
}
System.String requestSourceUser_sourceUser_ProviderName = null;
if (cmdletContext.SourceUser_ProviderName != null)
{
requestSourceUser_sourceUser_ProviderName = cmdletContext.SourceUser_ProviderName;
}
if (requestSourceUser_sourceUser_ProviderName != null)
{
request.SourceUser.ProviderName = requestSourceUser_sourceUser_ProviderName;
requestSourceUserIsNull = false;
}
// determine if request.SourceUser should be set to null
if (requestSourceUserIsNull)
{
request.SourceUser = 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.AdminLinkProviderForUserResponse CallAWSServiceOperation(IAmazonCognitoIdentityProvider client, Amazon.CognitoIdentityProvider.Model.AdminLinkProviderForUserRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Cognito Identity Provider", "AdminLinkProviderForUser");
try
{
#if DESKTOP
return client.AdminLinkProviderForUser(request);
#elif CORECLR
return client.AdminLinkProviderForUserAsync(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 DestinationUser_ProviderAttributeName { get; set; }
public System.String DestinationUser_ProviderAttributeValue { get; set; }
public System.String DestinationUser_ProviderName { get; set; }
public System.String SourceUser_ProviderAttributeName { get; set; }
public System.String SourceUser_ProviderAttributeValue { get; set; }
public System.String SourceUser_ProviderName { get; set; }
public System.String UserPoolId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}