PNG  IHDR;IDATxܻn0K )(pA 7LeG{ §㻢|ذaÆ 6lذaÆ 6lذaÆ 6lom$^yذag5bÆ 6lذaÆ 6lذa{ 6lذaÆ `}HFkm,mӪôô! x|'ܢ˟;E:9&ᶒ}{v]n&6 h_tڠ͵-ҫZ;Z$.Pkž)!o>}leQfJTu іچ\X=8Rن4`Vwl>nG^is"ms$ui?wbs[m6K4O.4%/bC%t Mז -lG6mrz2s%9s@-k9=)kB5\+͂Zsٲ Rn~GRC wIcIn7jJhۛNCS|j08yiHKֶۛkɈ+;SzL/F*\Ԕ#"5m2[S=gnaPeғL lذaÆ 6l^ḵaÆ 6lذaÆ 6lذa; _ذaÆ 6lذaÆ 6lذaÆ RIENDB` package Paws::CognitoIdp::CreateUserPoolClient; use Moose; has AccessTokenValidity => (is => 'ro', isa => 'Int'); has AllowedOAuthFlows => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); has AllowedOAuthFlowsUserPoolClient => (is => 'ro', isa => 'Bool'); has AllowedOAuthScopes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); has AnalyticsConfiguration => (is => 'ro', isa => 'Paws::CognitoIdp::AnalyticsConfigurationType'); has CallbackURLs => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); has ClientName => (is => 'ro', isa => 'Str', required => 1); has DefaultRedirectURI => (is => 'ro', isa => 'Str'); has EnableTokenRevocation => (is => 'ro', isa => 'Bool'); has ExplicitAuthFlows => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); has GenerateSecret => (is => 'ro', isa => 'Bool'); has IdTokenValidity => (is => 'ro', isa => 'Int'); has LogoutURLs => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); has PreventUserExistenceErrors => (is => 'ro', isa => 'Str'); has ReadAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); has RefreshTokenValidity => (is => 'ro', isa => 'Int'); has SupportedIdentityProviders => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); has TokenValidityUnits => (is => 'ro', isa => 'Paws::CognitoIdp::TokenValidityUnitsType'); has UserPoolId => (is => 'ro', isa => 'Str', required => 1); has WriteAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateUserPoolClient'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::CreateUserPoolClientResponse'); class_has _result_key => (isa => 'Str', is => 'ro'); 1; ### main pod documentation begin ### =head1 NAME Paws::CognitoIdp::CreateUserPoolClient - Arguments for method CreateUserPoolClient on L =head1 DESCRIPTION This class represents the parameters used for calling the method CreateUserPoolClient on the L service. Use the attributes of this class as arguments to method CreateUserPoolClient. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateUserPoolClient. =head1 SYNOPSIS my $cognito-idp = Paws->service('CognitoIdp'); my $CreateUserPoolClientResponse = $cognito -idp->CreateUserPoolClient( ClientName => 'MyClientNameType', UserPoolId => 'MyUserPoolIdType', AccessTokenValidity => 1, # OPTIONAL AllowedOAuthFlows => [ 'code', ... # values: code, implicit, client_credentials ], # OPTIONAL AllowedOAuthFlowsUserPoolClient => 1, # OPTIONAL AllowedOAuthScopes => [ 'MyScopeType', ... # min: 1, max: 256 ], # OPTIONAL AnalyticsConfiguration => { ApplicationArn => 'MyArnType', # min: 20, max: 2048; OPTIONAL ApplicationId => 'MyHexStringType', # OPTIONAL ExternalId => 'MyStringType', # OPTIONAL RoleArn => 'MyArnType', # min: 20, max: 2048; OPTIONAL UserDataShared => 1, }, # OPTIONAL CallbackURLs => [ 'MyRedirectUrlType', ... # min: 1, max: 1024 ], # OPTIONAL DefaultRedirectURI => 'MyRedirectUrlType', # OPTIONAL EnableTokenRevocation => 1, # OPTIONAL ExplicitAuthFlows => [ 'ADMIN_NO_SRP_AUTH', ... # values: ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH ], # OPTIONAL GenerateSecret => 1, # OPTIONAL IdTokenValidity => 1, # OPTIONAL LogoutURLs => [ 'MyRedirectUrlType', ... # min: 1, max: 1024 ], # OPTIONAL PreventUserExistenceErrors => 'LEGACY', # OPTIONAL ReadAttributes => [ 'MyClientPermissionType', ... # min: 1, max: 2048 ], # OPTIONAL RefreshTokenValidity => 1, # OPTIONAL SupportedIdentityProviders => [ 'MyProviderNameType', ... # min: 1, max: 32 ], # OPTIONAL TokenValidityUnits => { AccessToken => 'seconds', # values: seconds, minutes, hours, days; OPTIONAL IdToken => 'seconds', # values: seconds, minutes, hours, days; OPTIONAL RefreshToken => 'seconds', # values: seconds, minutes, hours, days; OPTIONAL }, # OPTIONAL WriteAttributes => [ 'MyClientPermissionType', ... # min: 1, max: 2048 ], # OPTIONAL ); # Results: my $UserPoolClient = $CreateUserPoolClientResponse->UserPoolClient; # Returns a L object. Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see L =head1 ATTRIBUTES =head2 AccessTokenValidity => Int The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits. =head2 AllowedOAuthFlows => ArrayRef[Str|Undef] The allowed OAuth flows. Set to C 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 C to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly. Set to C to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret. =head2 AllowedOAuthFlowsUserPoolClient => Bool Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools. =head2 AllowedOAuthScopes => ArrayRef[Str|Undef] The allowed OAuth scopes. Possible values provided by OAuth are: C, C, C, and C. Possible values provided by AWS are: C. Custom scopes created in Resource Servers are also supported. =head2 AnalyticsConfiguration => L The Amazon Pinpoint analytics configuration for collecting metrics for this user pool. In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region. =head2 CallbackURLs => ArrayRef[Str|Undef] A list of allowed redirect (callback) URLs for the identity providers. A redirect URI must: =over =item * Be an absolute URI. =item * Be registered with the authorization server. =item * Not include a fragment component. =back See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported. =head2 B ClientName => Str The client name for the user pool client you would like to create. =head2 DefaultRedirectURI => Str The default redirect URI. Must be in the C list. A redirect URI must: =over =item * Be an absolute URI. =item * Be registered with the authorization server. =item * Not include a fragment component. =back See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported. =head2 EnableTokenRevocation => Bool Enables or disables token revocation. For more information about revoking tokens, see RevokeToken (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html). If you don't include this parameter, token revocation is automatically enabled for the new user pool client. =head2 ExplicitAuthFlows => ArrayRef[Str|Undef] The authentication flows that are supported by the user pool clients. Flow names without the C prefix are deprecated in favor of new names with the C prefix. Note that values with C prefix cannot be used along with values without C prefix. Valid values include: =over =item * C: Enable admin based user password authentication flow C. This setting replaces the C setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords. =item * C: Enable Lambda trigger based authentication. =item * C: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords. =item * C: Enable SRP based authentication. =item * C: Enable authflow to refresh tokens. =back =head2 GenerateSecret => Bool Boolean to specify whether you want to generate a secret for the user pool client being created. =head2 IdTokenValidity => Int The time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits. =head2 LogoutURLs => ArrayRef[Str|Undef] A list of allowed logout URLs for the identity providers. =head2 PreventUserExistenceErrors => Str Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to C and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to C, those APIs will return a C exception if the user does not exist in the user pool. Valid values include: =over =item * C - This prevents user existence-related errors. =item * C - This represents the old behavior of Cognito where user existence related errors are not prevented. =back After February 15th 2020, the value of C will default to C for newly created user pool clients if no value is provided. Valid values are: C<"LEGACY">, C<"ENABLED"> =head2 ReadAttributes => ArrayRef[Str|Undef] The read attributes. =head2 RefreshTokenValidity => Int The time limit, in days, after which the refresh token is no longer valid and cannot be used. =head2 SupportedIdentityProviders => ArrayRef[Str|Undef] A list of provider names for the identity providers that are supported on this client. The following are supported: C, C, C and C. =head2 TokenValidityUnits => L The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours. =head2 B UserPoolId => Str The user pool ID for the user pool where you want to create a user pool client. =head2 WriteAttributes => ArrayRef[Str|Undef] The user pool attributes that the app client can write to. If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html). =head1 SEE ALSO This class forms part of L, documenting arguments for method CreateUserPoolClient in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut