Paws::CognitoIdp::UserPoolClientType
This class represents one of two things:
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::CognitoIdp::UserPoolClientType object:
$service_obj->Method(Att1 => { AccessTokenValidity => $value, ..., WriteAttributes => $value });
Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::UserPoolClientType object:
$result = $service_obj->Method(...); $result->Att1->AccessTokenValidity
Contains information about a user pool client.
The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and cannot be used.
The allowed OAuth flows.
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.
code
Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
implicit
Set to client_credentials 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.
client_credentials
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
phone
email
openid
profile
aws.cognito.signin.user.admin
The Amazon Pinpoint analytics configuration for the user pool client.
Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
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 (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.
The ID of the client associated with the user pool.
The client name from the user pool request of the client type.
The client secret from the user pool request of the client type.
The date the user pool client was created.
The default redirect URI. Must be in the CallbackURLs list.
CallbackURLs
Indicates whether token revocation is enabled for the user pool client. When you create a new user pool client, token revocation is enabled by default. For more information about revoking tokens, see RevokeToken (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html).
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
ALLOW_
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, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
ALLOW_ADMIN_USER_PASSWORD_AUTH
ADMIN_USER_PASSWORD_AUTH
ADMIN_NO_SRP_AUTH
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_CUSTOM_AUTH
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_PASSWORD_AUTH
ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
ALLOW_USER_SRP_AUTH
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
ALLOW_REFRESH_TOKEN_AUTH
The time limit, specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and cannot be used.
The date the user pool client was last modified.
A list of allowed logout URLs for the identity providers.
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 ENABLED 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 LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
ENABLED
LEGACY
UserNotFoundException
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
PreventUserExistenceErrors
The Read-only attributes.
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
A list of provider names for the identity providers that are supported on this client.
The time units used to specify the token validity times of their respective token.
The user pool ID for the user pool client.
The writeable attributes.
This class forms part of Paws, describing an object used in Paws::CognitoIdp
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws
CPAN shell
perl -MCPAN -e shell install Paws
For more information on module installation, please visit the detailed CPAN module installation guide.