-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) |
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) |
Aliases | AllowedOAuthFlows |
-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) |
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) |
Aliases | AllowedOAuthScopes |
-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) |
-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) |
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) |
Amazon.PowerShell.Cmdlets.CGIP.AmazonCognitoIdentityProviderClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The client name for the user pool client you would like to create.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
-EnablePropagateAdditionalUserContextData <
Boolean>
Activates the propagation of additional user context data. For more information about propagation of user context data, see
Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate
EnablePropagateAdditionalUserContextData
in an app client that has a client secret.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
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 user client supports
ALLOW_REFRESH_TOKEN_AUTH
,
ALLOW_USER_SRP_AUTH
, and
ALLOW_CUSTOM_AUTH
.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, 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) |
Aliases | ExplicitAuthFlows |
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) |
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) |
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.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) |
A list of allowed logout URLs for the IdPs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
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) |
Aliases | PreventUserExistenceErrors |
The read attributes.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ReadAttributes |
-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) |
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) |
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
.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SupportedIdentityProviders |
A time unit of seconds
, minutes
, hours
, or days
for the value that you set in the AccessTokenValidity
parameter. The default AccessTokenValidity
time unit is hours.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A time unit of seconds
, minutes
, hours
, or days
for the value that you set in the IdTokenValidity
parameter. The default IdTokenValidity
time unit is hours.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A time unit of seconds
, minutes
, hours
, or days
for the value that you set in the RefreshTokenValidity
parameter. The default RefreshTokenValidity
time unit is days.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
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) |
Aliases | WriteAttributes |