Synopsis
Calls the Amazon Cognito Identity Provider AdminInitiateAuth API operation.
Syntax
Start-CGIPAuthAdmin-ClientId <String>-AnalyticsMetadata_AnalyticsEndpointId <String>-AuthFlow <AuthFlowType>-AuthParameter <Hashtable>-ClientMetadata <Hashtable>-ContextData_EncodedData <String>-ContextData_HttpHeader <HttpHeader[]>-ContextData_IpAddress <String>-ContextData_ServerName <String>-ContextData_ServerPath <String>-UserPoolId <String>-Force <SwitchParameter>
Description
Initiates the authentication flow, as an administrator.
Calling this action requires developer credentials.
Parameters
-AnalyticsMetadata_AnalyticsEndpointId <String>
The endpoint ID.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-AuthFlow <AuthFlowType>
The authentication flow for this call to execute. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTHwill take in a valid refresh token and return new tokens.USER_SRP_AUTHwill take inUSERNAMEandSRP_Aand return the SRP variables to be used for next challenge execution.USER_PASSWORD_AUTHwill take inUSERNAMEandPASSWORDand return the next challenge or tokens.
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.CUSTOM_AUTH: Custom authentication flow.ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-AuthParameter <Hashtable>
The authentication parameters. These are inputs corresponding to the
AuthFlow that you are invoking. The required values depend on the value of AuthFlow:- For
USER_SRP_AUTH:USERNAME(required),SRP_A(required),SECRET_HASH(required if the app client is configured with a client secret),DEVICE_KEY - For
REFRESH_TOKEN_AUTH/REFRESH_TOKEN:REFRESH_TOKEN(required),SECRET_HASH(required if the app client is configured with a client secret),DEVICE_KEY - For
ADMIN_NO_SRP_AUTH:USERNAME(required),SECRET_HASH(if app client is configured with client secret),PASSWORD(required),DEVICE_KEY - For
CUSTOM_AUTH:USERNAME(required),SECRET_HASH(if app client is configured with client secret),DEVICE_KEY
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | AuthParameters |
-ClientId <String>
The app client ID.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ByPropertyName) |
-ClientMetadata <Hashtable>
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
- Pre signup
- Pre authentication
- User migration
validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in AWS Lambda, you can process the validationData value to enhance your workflow for your specific needs.When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it does not provide the ClientMetadata value as input:- Post authentication
- Custom message
- Pre token generation
- Create auth challenge
- Define auth challenge
- Verify auth challenge
- Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ContextData_EncodedData <String>
Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ContextData_HttpHeader <HttpHeader[]>
HttpHeaders received on your server in same order.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ContextData_HttpHeaders |
-ContextData_IpAddress <String>
Source IP address of your user.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ContextData_ServerName <String>
Your server endpoint where this API is invoked.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ContextData_ServerPath <String>
Your server path where this API is invoked.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-UserPoolId <String>
The ID of the Amazon Cognito user pool.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | AK |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | AWSProfilesLocation, ProfilesLocation |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | AWSProfileName, StoredCredentials |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | SecretAccessKey, SK |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ST |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | RegionToCall |
-EndpointUrl <String>
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Inputs
You can pipe a String object to this cmdlet for the ClientId parameter.
Outputs
This cmdlet returns a Amazon.CognitoIdentityProvider.Model.AdminInitiateAuthResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
