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>
-AllowedOAuthFlow <String[]>
-AllowedOAuthFlowsUserPoolClient <Boolean>
-AllowedOAuthScope <String[]>
-AnalyticsConfiguration_ApplicationId <String>
-CallbackURLs <String[]>
-ClientName <String>
-DefaultRedirectURI <String>
-ExplicitAuthFlow <String[]>
-AnalyticsConfiguration_ExternalId <String>
-GenerateSecret <Boolean>
-LogoutURLs <String[]>
-ReadAttribute <String[]>
-RefreshTokenValidity <Int32>
-AnalyticsConfiguration_RoleArn <String>
-SupportedIdentityProvider <String[]>
-AnalyticsConfiguration_UserDataShared <Boolean>
-WriteAttribute <String[]>
-Force <SwitchParameter>

Description

Creates the user pool client.

Parameters

-AllowedOAuthFlow <String[]>
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 token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-AllowedOAuthScope <String[]>
A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
Required?False
Position?Named
Accept pipeline input?False
-AnalyticsConfiguration_ApplicationId <String>
The application ID for an Amazon Pinpoint application.
Required?False
Position?Named
Accept pipeline input?False
-AnalyticsConfiguration_ExternalId <String>
The external ID.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-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?False
-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?False
-ClientName <String>
The client name for the user pool client you would like to create.
Required?False
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?False
-ExplicitAuthFlow <String[]>
The explicit authentication flows.
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
-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?False
-LogoutURLs <String[]>
A list of allowed logout URLs for the identity providers.
Required?False
Position?Named
Accept pipeline input?False
-ReadAttribute <String[]>
The read attributes.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-SupportedIdentityProvider <String[]>
A list of provider names for the identity providers that are supported on this client.
Required?False
Position?Named
Accept pipeline input?False
-UserPoolId <String>
The user pool ID for the user pool where you want to create a user pool client.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-WriteAttribute <String[]>
The write attributes.
Required?False
Position?Named
Accept pipeline input?False

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
-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
-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
-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
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-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
-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

System.String
You can pipe a String object to this cmdlet for the UserPoolId parameter.

Outputs

Amazon.CognitoIdentityProvider.Model.UserPoolClientType
This cmdlet returns a 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.
AWS Tools for PowerShell User Guide

Supported Version

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