AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Cognito Identity Provider CreateUserPoolClient API operation.

Syntax

New-CGIPUserPoolClient
-UserPoolId <String>
-TokenValidityUnits_AccessToken <TimeUnitsType>
-AccessTokenValidity <Int32>
-AllowedOAuthFlow <String[]>
-AllowedOAuthFlowsUserPoolClient <Boolean>
-AllowedOAuthScope <String[]>
-AnalyticsConfiguration_ApplicationArn <String>
-AnalyticsConfiguration_ApplicationId <String>
-CallbackURLs <String[]>
-ClientName <String>
-DefaultRedirectURI <String>
-EnableTokenRevocation <Boolean>
-ExplicitAuthFlow <String[]>
-AnalyticsConfiguration_ExternalId <String>
-GenerateSecret <Boolean>
-TokenValidityUnits_IdToken <TimeUnitsType>
-IdTokenValidity <Int32>
-LogoutURLs <String[]>
-PreventUserExistenceError <PreventUserExistenceErrorTypes>
-ReadAttribute <String[]>
-TokenValidityUnits_RefreshToken <TimeUnitsType>
-RefreshTokenValidity <Int32>
-AnalyticsConfiguration_RoleArn <String>
-SupportedIdentityProvider <String[]>
-AnalyticsConfiguration_UserDataShared <Boolean>
-WriteAttribute <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates the user pool client. When you create a new user pool client, token revocation is automatically enabled. For more information about revoking tokens, see RevokeToken.

Parameters

-AccessTokenValidity <Int32>
The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AllowedOAuthFlow <String[]>
The allowed OAuth flows.Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAllowedOAuthFlows
-AllowedOAuthFlowsUserPoolClient <Boolean>
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AllowedOAuthScope <String[]>
The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAllowedOAuthScopes
-AnalyticsConfiguration_ApplicationArn <String>
The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for Pinpoint integration with the chosen User Pool Client. Amazon Cognito publishes events to the pinpoint project declared by the app ARN.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnalyticsConfiguration_ApplicationId <String>
The application ID for an Amazon Pinpoint application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnalyticsConfiguration_ExternalId <String>
The external ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnalyticsConfiguration_RoleArn <String>
The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnalyticsConfiguration_UserDataShared <Boolean>
If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CallbackURLs <String[]>
A list of allowed redirect (callback) URLs for the identity providers.A redirect URI must:
  • Be an absolute URI.
  • Be registered with the authorization server.
  • Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.App callback URLs such as myapp://example are also supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientName <String>
The client name for the user pool client you would like to create.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRedirectURI <String>
The default redirect URI. Must be in the CallbackURLs list.A redirect URI must:
  • Be an absolute URI.
  • Be registered with the authorization server.
  • Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.App callback URLs such as myapp://example are also supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableTokenRevocation <Boolean>
Enables or disables token revocation. For more information about revoking tokens, see RevokeToken.If you don't include this parameter, token revocation is automatically enabled for the new user pool client.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExplicitAuthFlow <String[]>
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.Valid values include:
  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
  • ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExplicitAuthFlows
-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?True (ByPropertyName)
-GenerateSecret <Boolean>
Boolean to specify whether you want to generate a secret for the user pool client being created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdTokenValidity <Int32>
The time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogoutURLs <String[]>
A list of allowed logout URLs for the identity providers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreventUserExistenceError <PreventUserExistenceErrorTypes>
Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.Valid values include:
  • ENABLED - This prevents user existence-related errors.
  • LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreventUserExistenceErrors
-ReadAttribute <String[]>
The read attributes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReadAttributes
-RefreshTokenValidity <Int32>
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'UserPoolClient'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentityProvider.Model.CreateUserPoolClientResponse). Specifying the name of a property of type Amazon.CognitoIdentityProvider.Model.CreateUserPoolClientResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SupportedIdentityProvider <String[]>
A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO, Facebook, Google and LoginWithAmazon.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSupportedIdentityProviders
-TokenValidityUnits_AccessToken <TimeUnitsType>
A time unit in “seconds”, “minutes”, “hours” or “days” for the value in AccessTokenValidity, defaults to hours.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TokenValidityUnits_IdToken <TimeUnitsType>
A time unit in “seconds”, “minutes”, “hours” or “days” for the value in IdTokenValidity, defaults to hours.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TokenValidityUnits_RefreshToken <TimeUnitsType>
A time unit in “seconds”, “minutes”, “hours” or “days” for the value in RefreshTokenValidity, defaults to days.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserPoolId <String>
The user pool ID for the user pool where you want to create a user pool client.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-WriteAttribute <String[]>
The user pool attributes that the app client can write to.If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteAttributes

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, 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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.CognitoIdentityProvider.Model.UserPoolClientType or Amazon.CognitoIdentityProvider.Model.CreateUserPoolClientResponse
This cmdlet returns an Amazon.CognitoIdentityProvider.Model.UserPoolClientType object. The service call response (type Amazon.CognitoIdentityProvider.Model.CreateUserPoolClientResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z