ICognitoIdentityProviderUpdateUserPoolClientRequest

Interface in AWS.CognitoIdentityProvider

Interface for UpdateUserPoolClient requests.

Ancestors

• ICognitoIdentityProviderRequest

Properties

AccessTokenValidity

property AccessTokenValidity: TOptional<Integer>

Specify the access token time limit.

Valid range: 1 - 86400. Specifying the AccessTokenValidity will change the period of time an access token is valid for. Specify the units by setting TokenValidityUnits. If not specified, tokens expire after 1 hour.

AllowedOAuthFlows

property AllowedOAuthFlows: TList<string>

Specify the allowed OAuth flows.

Valid values: - code: allow code grant flow. - implicit: allow implicit flow. - client_credentials: allow client credentials flow.

AllowedOAuthFlowsUserPoolClient

property AllowedOAuthFlowsUserPoolClient: TOptional<Boolean>

Specify if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

AllowedOAuthScopes

property AllowedOAuthScopes: TList<string>

Specify a list of allowed OAuth scopes.

Possible values provided by OAuth are: phone | email | openid | profile. Possible values provided by Amazon Cognito are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

AnalyticsConfiguration

property AnalyticsConfiguration: ICognitoIdentityProviderAnalyticsConfigurationType

Type: ICognitoIdentityProviderAnalyticsConfigurationType

Specify the user pool configuration for collecting metrics and sending them to Amazon Pinpoint.

AuthSessionValidity

property AuthSessionValidity: TOptional<Integer>

Specify the duration in minutes that a session is valid for.

Valid range: 3 - 15.

CallbackURLs

property CallbackURLs: TList<string>

Specify a list of allowed redirect (callback) URLs for the IdPs.

A redirect URL must: - be an absolute URI - be registered with the authorization server - not include a fragment component Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.

ClientId

property ClientId: string

Specify the ID of the app client.

ClientName

property ClientName: string

Specify a name for the user pool client.

DefaultCallbackURI

property DefaultCallbackURI: string

Specify the default callback URI.

Must be in the CallbackURLs list.

EnablePropagateAdditionalUserContextData

property EnablePropagateAdditionalUserContextData: TOptional<Boolean>

Specify True to activate propagation of additional user context data.

If not specified/activated, you can't send device fingerprint information including source IP address to Amazon Cognito advanced security. Can only be activated for app clients that have a client secret.

EnableTokenRevocation

property EnableTokenRevocation: TOptional<Boolean>

Specify to activate or deactivate token revocation.

If not specified, token revocation will be activated by default.

ExplicitAuthFlows

property ExplicitAuthFlows: TList<string>

Specify the authentication flows that you want the user pool client to support.

Valid values: - ALLOW_ADMIN_USER_PASSWORD_AUTH: Allow admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication. - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. - ALLOW_USER_SRP_AUTH: Enable SRP-based authentication. - ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

IdTokenValidity

property IdTokenValidity: TOptional<Integer>

Specify a time limit for the ID token.

Valid range: 1 - 86400. Specifying the IdTokenValidity will change the period of time an ID token is valid for. Specify the units by setting TokenValidityUnits. If not specified, tokens expire after 1 hour.

LogoutURLs

property LogoutURLs: TList<string>

Specify a list of allowed logout URLs for the Identity Providers (IdPs).

PreventUserExistenceErrors

property PreventUserExistenceErrors: string

Specify whether API calls that may confirm the existence of a user raise errors confirming the existence of a user or not.

Valid values: - ENABLED: When a user does not exist, error responses will be generated to indicate users or passwords were incorrect. - LEGACY: When a user does not exist, ECognitoIdentityProviderUserNotFoundException will be raised.

ReadAttributes

property ReadAttributes: TList<string>

Specify the read attributes.

RefreshTokenValidity

property RefreshTokenValidity: TOptional<Integer>

Specify a time limit for the refresh token validity.

Valid range: 0 - 315360000. Specifying the RefreshTokenValidity will change the period of time a refresh token is valid for. Specify the units by setting TokenValidityUnits. If not specified, refresh tokens expire after 30 days.

SupportedIdentityProviders

property SupportedIdentityProviders: TList<string>

Specify a list of names of Identity Providers (IdPs) that are supported by this client.

The following values are supported: COGNITO, Facebook, Google, SignInWithApple, and LoginWithAmazon. Names of SAML and OIDC IdPs configured for your user pool can also be specified.

TokenValidityUnits

property TokenValidityUnits: ICognitoIdentityProviderTokenValidityUnitsType

Type: ICognitoIdentityProviderTokenValidityUnitsType

Specify units in which the validity values for tokens are specified.

UserPoolId

property UserPoolId: string

Specify the ID of the user pool.

WriteAttributes

property WriteAttributes: TList<string>

Specify the user pool atrributes that the app client can write to.

If your app client allows signing in through an Identity Provider (IdP) this list must include all the attributes that have been mapped to IdP attributes.

Methods

AddAllowedOAuthFlow

function AddAllowedOAuthFlow(const AAllowedOAuthFlow: string): Integer;

Add an allowed OAuth flow to AllowedOAuthFlows.

Parameters

Name	Description
AAllowedOAuthFlow	Specify an allowed OAuth flow.

Returns

Returns the index of the added allowed OAuth flow.

AddAllowedOAuthScope

function AddAllowedOAuthScope(const AAllowedOAuthScope: string): Integer;

Add an allowed OAuth scope to AllowedOAuthScopes.

Parameters

Name	Description
AAllowedOAuthScope	Specify an allowed OAuth scope.

Returns

Returns the index of the allowed OAuth scope to AllowedOAuthScopes.

AddCallbackURL

function AddCallbackURL(const ACallbackURL: string): Integer;

Add a callback URL to CallbackURLs.

Parameters

Name	Description
ACallbackURL	Specify a URL to add to CallbackURLs.

Returns

Returns the index of the URL added to CallbackURLs.

AddExplicitAuthFlow

function AddExplicitAuthFlow(const AExplicitAuthFlow: string): Integer;

Add an authentication flow to ExplicitAuthFlows.

Parameters

Name	Description
AExplicitAuthFlow	Specify an authentication flow.

Returns

Returns the index of the added authentication flow.

AddLogoutURL

function AddLogoutURL(const ALogoutURL: string): Integer;

Add a URL to LogoutURLs.

Parameters

Name	Description
ALogoutURL	Specify a URL to add to LogoutURLs.

Returns

Returns the index of the URL added to LogoutURLs.

AddReadAttribute

function AddReadAttribute(const AReadAttribute: string): Integer;

Add an attribute to ReadAttributes.

Parameters

Name	Description
AReadAttribute	Specify an attribute to add to ReadAttributes.

Returns

Returns the index of the attribute added to ReadAttributes.

AddSupportedIdentityProvider

function AddSupportedIdentityProvider(const ASupportedIdentityProvider: string): Integer;

Add an identity provider to SupportedIdentityProviders.

Parameters

Name	Description
ASupportedIdentityProvider	Specify an Identity Provider (IdP) to add to SupportedIdentityProviders.

Returns

Returns the index of the IdentityProvider (IdP) added to SupportedIdentityProviders.

AddWriteAttribute

function AddWriteAttribute(const AWriteAttribute: string): Integer;

Add an attribute to to WriteAttributes.

Parameters

Name	Description
AWriteAttribute	Specify an attribute to add to WriteAttributes.

Returns

Returns the index of the attribute added to WriteAttributes.