NAME

Paws::CognitoIdp::UserPoolClientType

USAGE

This class represents one of two things:

Arguments in a call to a service

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 => { AllowedOAuthFlows => $value, ..., WriteAttributes => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::UserPoolClientType object:

  $result = $service_obj->Method(...);
  $result->Att1->AllowedOAuthFlows

DESCRIPTION

Contains information about a user pool client.

ATTRIBUTES

AllowedOAuthFlows => ArrayRef[Str|Undef]

  Set to C<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.

AllowedOAuthFlowsUserPoolClient => Bool

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

AllowedOAuthScopes => ArrayRef[Str|Undef]

  A list of allowed C<OAuth> scopes. Currently supported values are
C<"phone">, C<"email">, C<"openid">, and C<"Cognito">.

AnalyticsConfiguration => Paws::CognitoIdp::AnalyticsConfigurationType

  The Amazon Pinpoint analytics configuration for the user pool client.

CallbackURLs => ArrayRef[Str|Undef]

  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.

ClientId => Str

  The ID of the client associated with the user pool.

ClientName => Str

  The client name from the user pool request of the client type.

ClientSecret => Str

  The client secret from the user pool request of the client type.

CreationDate => Str

  The date the user pool client was created.

DefaultRedirectURI => Str

  The default redirect URI. Must be in the C<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 (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.

ExplicitAuthFlows => ArrayRef[Str|Undef]

  The explicit authentication flows.

LastModifiedDate => Str

  The date the user pool client was last modified.

LogoutURLs => ArrayRef[Str|Undef]

  A list of allowed logout URLs for the identity providers.

ReadAttributes => ArrayRef[Str|Undef]

  The Read-only attributes.

RefreshTokenValidity => Int

  The time limit, in days, after which the refresh token is no longer
valid and cannot be used.

SupportedIdentityProviders => ArrayRef[Str|Undef]

  A list of provider names for the identity providers that are supported
on this client.

UserPoolId => Str

  The user pool ID for the user pool client.

WriteAttributes => ArrayRef[Str|Undef]

  The writeable attributes.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::CognitoIdp

BUGS and CONTRIBUTIONS

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