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 activated. For more information about revoking tokens, see RevokeToken.

Parameters

-AccessTokenValidity <Int32>
The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AllowedOAuthFlow <String[]>
The allowed OAuth flows.
code
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
implicit
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
client_credentials
Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID 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 Amazon 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 to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
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 Identity and Access Management 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 includes user data in the events that 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 IdPs.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>
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.If you don't include this parameter, token revocation is automatically activated 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 no longer supported, in favor of new names with the ALLOW_ prefix.Values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon 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.
If you don't specify a value for ExplicitAuthFlows, your app client activates the ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
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 ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogoutURLs <String[]>
A list of allowed logout URLs for the IdPs.
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>
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.Valid values include:
  • ENABLED - This prevents user existence-related errors.
  • LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.
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 refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
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 IdPs that this client supports. The following are supported: COGNITO, Facebook, GoogleLoginWithAmazon, and the names of your own SAML and OIDC providers.
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, defaulting 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, defaulting 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, defaulting 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 IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP 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