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>
-AuthSessionValidity <Int32>
-CallbackURLs <String[]>
-ClientName <String>
-DefaultRedirectURI <String>
-EnablePropagateAdditionalUserContextData <Boolean>
-EnableTokenRevocation <Boolean>
-ExplicitAuthFlow <String[]>
-AnalyticsConfiguration_ExternalId <String>
-RefreshTokenRotation_Feature <FeatureType>
-GenerateSecret <Boolean>
-TokenValidityUnits_IdToken <TimeUnitsType>
-IdTokenValidity <Int32>
-LogoutURLs <String[]>
-PreventUserExistenceError <PreventUserExistenceErrorTypes>
-ReadAttribute <String[]>
-TokenValidityUnits_RefreshToken <TimeUnitsType>
-RefreshTokenValidity <Int32>
-RefreshTokenRotation_RetryGracePeriodSecond <Int32>
-AnalyticsConfiguration_RoleArn <String>
-SupportedIdentityProvider <String[]>
-AnalyticsConfiguration_UserDataShared <Boolean>
-WriteAttribute <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonCognitoIdentityProviderConfig>

Description

Creates an app client in a user pool. This operation sets basic and advanced configuration options. Unlike app clients created in the console, Amazon Cognito doesn't automatically assign a branding style to app clients that you configure with this API operation. Managed login and classic hosted UI pages aren't available for your client until after you apply a branding style. If you don't provide a value for an attribute, Amazon Cognito sets it to its default value. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more

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.If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AllowedOAuthFlow <String[]>
The OAuth grant types that you want your app client to generate for clients in managed login authentication. To create an app client that generates client credentials grants, you must add client_credentials as the only allowed OAuth flow.
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 the ID token when scopes like openid and profile are requested, directly to your user.
client_credentials
Issue the access token from the /oauth2/token endpoint directly to a non-person user, authorized by a combination of the client ID and client secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAllowedOAuthFlows
-AllowedOAuthFlowsUserPoolClient <Boolean>
Set to true to use OAuth 2.0 authorization server features in your app client.This parameter must have a value of true before you can configure the following features in your app client.
  • CallBackURLs: Callback URLs.
  • LogoutURLs: Sign-out redirect URLs.
  • AllowedOAuthScopes: OAuth 2.0 scopes.
  • AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use authorization server features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults to false. When false, only SDK-based API sign-in is permitted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AllowedOAuthScope <String[]>
The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with. Scopes govern access control to user pool self-service API operations, user data from the userInfo endpoint, and third-party APIs. Scope values include phone, email, openid, and profile. The aws.cognito.signin.user.admin scope authorizes user self-service operations. Custom scopes with resource servers authorize access to external APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAllowedOAuthScopes
-AnalyticsConfiguration_ApplicationArn <String>
The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that ApplicationArn declares. You can also configure your application to pass an endpoint ID in the AnalyticsMetadata parameter of sign-in operations. The endpoint ID is information about the destination for push notifications
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnalyticsConfiguration_ApplicationId <String>
Your Amazon Pinpoint project ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnalyticsConfiguration_ExternalId <String>
The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnalyticsConfiguration_RoleArn <String>
The ARN of an Identity and Access Management role that has the permissions required for 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)
-AuthSessionValidity <Int32>
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CallbackURLs <String[]>
A list of allowed redirect, or callback, URLs for managed login authentication. These URLs are the paths where you want to send your users' browsers after they complete authentication with managed login or a third-party IdP. Typically, callback URLs are the home of an application that uses OAuth or OIDC libraries to process authentication outcomes.A redirect URI must meet the following requirements:
  • Be an absolute URI.
  • Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with redirect_uri values that aren't in the list of CallbackURLs that you provide in this parameter.
  • 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)
-ClientConfig <AmazonCognitoIdentityProviderConfig>
Amazon.PowerShell.Cmdlets.CGIP.AmazonCognitoIdentityProviderClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientName <String>
A friendly name for the app client that you want to create.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRedirectURI <String>
The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri in authentication requests. Must be in the CallbackURLs list.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnablePropagateAdditionalUserContextData <Boolean>
When true, your application can include additional UserContextData in authentication requests. This data includes the IP address, and contributes to analysis by threat protection features. For more information about propagation of user context data, see Adding session data to API requests. If you don’t include this parameter, you can't send the source IP address to Amazon Cognito threat protection features. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableTokenRevocation <Boolean>
Activates or deactivates token revocation in the target app client.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 you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.If you don't specify a value for ExplicitAuthFlows, your app client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.The values for authentication flow options include the following.
  • ALLOW_USER_AUTH: Enable selection-based sign-in with USER_AUTH. This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without other ExplicitAuthFlows permitting them. For example users can complete an SRP challenge through USER_AUTH without the flow USER_SRP_AUTH being active for the app client. This flow doesn't include CUSTOM_AUTH. To activate this setting, your user pool must be in the Essentials tier or higher.
  • 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, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
  • 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.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.
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>
When true, generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. Client secrets are automatically generated; you can't specify a secret value. For more information, see App client types.
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 IdTokenValidity in an API request is hours. Valid range is displayed below in seconds.If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogoutURLs <String[]>
A list of allowed logout URLs for managed login authentication. When you pass logout_uri and client_id parameters to /logout, Amazon Cognito signs out your user and redirects them to the logout URL. This parameter describes the URLs that you want to be the permitted targets of logout_uri. A typical use of these URLs is when a user selects "Sign out" and you redirect them to your public homepage. For more information, see Logout endpoint.
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>
When ENABLED, suppresses messages that might indicate a valid user exists when someone attempts sign-in. This parameters sets your preference for the 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.Defaults to LEGACY.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreventUserExistenceErrors
-ReadAttribute <String[]>
The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list.When you don't specify the ReadAttributes for your app client, your app can read the values of email_verified, phone_number_verified, and the standard attributes of your user pool. When your user pool app client has read access to these default attributes, ReadAttributes doesn't return any information. Amazon Cognito only populates ReadAttributes in the API response if you have specified your own custom set of read attributes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReadAttributes
-RefreshTokenRotation_Feature <FeatureType>
The state of refresh token rotation for the current app client.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RefreshTokenRotation_RetryGracePeriodSecond <Int32>
When you request a token refresh with GetTokensFromRefreshToken, the original refresh token that you're rotating out can remain valid for a period of time of up to 60 seconds. This allows for client-side retries. When RetryGracePeriodSeconds is 0, the grace period is disabled and a successful request immediately invalidates the submitted refresh token.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRefreshTokenRotation_RetryGracePeriodSeconds
-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.If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
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 (IdPs) that are supported on this client. The following are supported: COGNITO, Facebook, Google, SignInWithApple, and LoginWithAmazon. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP.This parameter sets the IdPs that managed login will display on the login page for your app client. The removal of COGNITO from this list doesn't prevent authentication operations for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent SDK-based authentication is to block access with a WAF rule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSupportedIdentityProviders
-TokenValidityUnits_AccessToken <TimeUnitsType>
A time unit for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours. AccessTokenValidity duration can range from five minutes to one day.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TokenValidityUnits_IdToken <TimeUnitsType>
A time unit for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours. IdTokenValidity duration can range from five minutes to one day.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TokenValidityUnits_RefreshToken <TimeUnitsType>
A time unit for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days. RefreshTokenValidity duration can range from 60 minutes to 10 years.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserPoolId <String>
The ID of the user pool where you want to create an app client.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-WriteAttribute <String[]>
The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list.When you don't specify the WriteAttributes for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, WriteAttributes doesn't return any information. Amazon Cognito only populates WriteAttributes in the API response if you have specified your own custom set of write attributes.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 be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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