File Coverage

blib/lib/Paws/CognitoIdp/UserPoolClientType.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CognitoIdp::UserPoolClientType;
2 1     1   348 use Moose;
  1         3  
  1         7  
3             has AllowedOAuthFlows => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
4             has AllowedOAuthFlowsUserPoolClient => (is => 'ro', isa => 'Bool');
5             has AllowedOAuthScopes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6             has CallbackURLs => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7             has ClientId => (is => 'ro', isa => 'Str');
8             has ClientName => (is => 'ro', isa => 'Str');
9             has ClientSecret => (is => 'ro', isa => 'Str');
10             has CreationDate => (is => 'ro', isa => 'Str');
11             has DefaultRedirectURI => (is => 'ro', isa => 'Str');
12             has ExplicitAuthFlows => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
13             has LastModifiedDate => (is => 'ro', isa => 'Str');
14             has LogoutURLs => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
15             has ReadAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
16             has RefreshTokenValidity => (is => 'ro', isa => 'Int');
17             has SupportedIdentityProviders => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
18             has UserPoolId => (is => 'ro', isa => 'Str');
19             has WriteAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
20             1;
21              
22             ### main pod documentation begin ###
23              
24             =head1 NAME
25              
26             Paws::CognitoIdp::UserPoolClientType
27              
28             =head1 USAGE
29              
30             This class represents one of two things:
31              
32             =head3 Arguments in a call to a service
33              
34             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
35             Each attribute should be used as a named argument in the calls that expect this type of object.
36              
37             As an example, if Att1 is expected to be a Paws::CognitoIdp::UserPoolClientType object:
38              
39             $service_obj->Method(Att1 => { AllowedOAuthFlows => $value, ..., WriteAttributes => $value });
40              
41             =head3 Results returned from an API call
42              
43             Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::UserPoolClientType object:
44              
45             $result = $service_obj->Method(...);
46             $result->Att1->AllowedOAuthFlows
47              
48             =head1 DESCRIPTION
49              
50             Contains information about a user pool client.
51              
52             =head1 ATTRIBUTES
53              
54              
55             =head2 AllowedOAuthFlows => ArrayRef[Str|Undef]
56              
57             Set to C<code> to initiate a code grant flow, which provides an
58             authorization code as the response. This code can be exchanged for
59             access tokens with the token endpoint.
60              
61             Set to C<token> to specify that the client should get the access token
62             (and, optionally, ID token, based on scopes) directly.
63              
64              
65             =head2 AllowedOAuthFlowsUserPoolClient => Bool
66              
67             Set to TRUE if the client is allowed to follow the OAuth protocol when
68             interacting with Cognito user pools.
69              
70              
71             =head2 AllowedOAuthScopes => ArrayRef[Str|Undef]
72              
73             A list of allowed C<OAuth> scopes. Currently supported values are
74             C<"phone">, C<"email">, C<"openid">, and C<"Cognito">.
75              
76              
77             =head2 CallbackURLs => ArrayRef[Str|Undef]
78              
79             A list of allowed callback URLs for the identity providers.
80              
81              
82             =head2 ClientId => Str
83              
84             The ID of the client associated with the user pool.
85              
86              
87             =head2 ClientName => Str
88              
89             The client name from the user pool request of the client type.
90              
91              
92             =head2 ClientSecret => Str
93              
94             The client secret from the user pool request of the client type.
95              
96              
97             =head2 CreationDate => Str
98              
99             The date the user pool client was created.
100              
101              
102             =head2 DefaultRedirectURI => Str
103              
104             The default redirect URI. Must be in the C<CallbackURLs> list.
105              
106              
107             =head2 ExplicitAuthFlows => ArrayRef[Str|Undef]
108              
109             The explicit authentication flows.
110              
111              
112             =head2 LastModifiedDate => Str
113              
114             The date the user pool client was last modified.
115              
116              
117             =head2 LogoutURLs => ArrayRef[Str|Undef]
118              
119             A list of allowed logout URLs for the identity providers.
120              
121              
122             =head2 ReadAttributes => ArrayRef[Str|Undef]
123              
124             The Read-only attributes.
125              
126              
127             =head2 RefreshTokenValidity => Int
128              
129             The time limit, in days, after which the refresh token is no longer
130             valid and cannot be used.
131              
132              
133             =head2 SupportedIdentityProviders => ArrayRef[Str|Undef]
134              
135             A list of provider names for the identity providers that are supported
136             on this client.
137              
138              
139             =head2 UserPoolId => Str
140              
141             The user pool ID for the user pool client.
142              
143              
144             =head2 WriteAttributes => ArrayRef[Str|Undef]
145              
146             The writeable attributes.
147              
148              
149              
150             =head1 SEE ALSO
151              
152             This class forms part of L<Paws>, describing an object used in L<Paws::CognitoIdp>
153              
154             =head1 BUGS and CONTRIBUTIONS
155              
156             The source code is located here: https://github.com/pplu/aws-sdk-perl
157              
158             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
159              
160             =cut
161