line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
1
|
|
|
|
|
|
|
|
2
|
|
|
|
|
|
|
package Paws::CognitoIdp::AdminInitiateAuthResponse; |
3
|
1
|
|
|
1
|
|
294
|
use Moose; |
|
1
|
|
|
|
|
3
|
|
|
1
|
|
|
|
|
5
|
|
4
|
|
|
|
|
|
|
has AuthenticationResult => (is => 'ro', isa => 'Paws::CognitoIdp::AuthenticationResultType'); |
5
|
|
|
|
|
|
|
has ChallengeName => (is => 'ro', isa => 'Str'); |
6
|
|
|
|
|
|
|
has ChallengeParameters => (is => 'ro', isa => 'Paws::CognitoIdp::ChallengeParametersType'); |
7
|
|
|
|
|
|
|
has Session => (is => 'ro', isa => 'Str'); |
8
|
|
|
|
|
|
|
|
9
|
|
|
|
|
|
|
has _request_id => (is => 'ro', isa => 'Str'); |
10
|
|
|
|
|
|
|
|
11
|
|
|
|
|
|
|
### main pod documentation begin ### |
12
|
|
|
|
|
|
|
|
13
|
|
|
|
|
|
|
=head1 NAME |
14
|
|
|
|
|
|
|
|
15
|
|
|
|
|
|
|
Paws::CognitoIdp::AdminInitiateAuthResponse |
16
|
|
|
|
|
|
|
|
17
|
|
|
|
|
|
|
=head1 ATTRIBUTES |
18
|
|
|
|
|
|
|
|
19
|
|
|
|
|
|
|
|
20
|
|
|
|
|
|
|
=head2 AuthenticationResult => L<Paws::CognitoIdp::AuthenticationResultType> |
21
|
|
|
|
|
|
|
|
22
|
|
|
|
|
|
|
The result of the authentication response. This is only returned if the |
23
|
|
|
|
|
|
|
caller does not need to pass another challenge. If the caller does need |
24
|
|
|
|
|
|
|
to pass another challenge before it gets tokens, C<ChallengeName>, |
25
|
|
|
|
|
|
|
C<ChallengeParameters>, and C<Session> are returned. |
26
|
|
|
|
|
|
|
|
27
|
|
|
|
|
|
|
|
28
|
|
|
|
|
|
|
=head2 ChallengeName => Str |
29
|
|
|
|
|
|
|
|
30
|
|
|
|
|
|
|
The name of the challenge which you are responding to with this call. |
31
|
|
|
|
|
|
|
This is returned to you in the C<AdminInitiateAuth> response if you |
32
|
|
|
|
|
|
|
need to pass another challenge. |
33
|
|
|
|
|
|
|
|
34
|
|
|
|
|
|
|
=over |
35
|
|
|
|
|
|
|
|
36
|
|
|
|
|
|
|
=item * |
37
|
|
|
|
|
|
|
|
38
|
|
|
|
|
|
|
C<SMS_MFA>: Next challenge is to supply an C<SMS_MFA_CODE>, delivered |
39
|
|
|
|
|
|
|
via SMS. |
40
|
|
|
|
|
|
|
|
41
|
|
|
|
|
|
|
=item * |
42
|
|
|
|
|
|
|
|
43
|
|
|
|
|
|
|
C<PASSWORD_VERIFIER>: Next challenge is to supply |
44
|
|
|
|
|
|
|
C<PASSWORD_CLAIM_SIGNATURE>, C<PASSWORD_CLAIM_SECRET_BLOCK>, and |
45
|
|
|
|
|
|
|
C<TIMESTAMP> after the client-side SRP calculations. |
46
|
|
|
|
|
|
|
|
47
|
|
|
|
|
|
|
=item * |
48
|
|
|
|
|
|
|
|
49
|
|
|
|
|
|
|
C<CUSTOM_CHALLENGE>: This is returned if your custom authentication |
50
|
|
|
|
|
|
|
flow determines that the user should pass another challenge before |
51
|
|
|
|
|
|
|
tokens are issued. |
52
|
|
|
|
|
|
|
|
53
|
|
|
|
|
|
|
=item * |
54
|
|
|
|
|
|
|
|
55
|
|
|
|
|
|
|
C<DEVICE_SRP_AUTH>: If device tracking was enabled on your user pool |
56
|
|
|
|
|
|
|
and the previous challenges were passed, this challenge is returned so |
57
|
|
|
|
|
|
|
that Amazon Cognito can start tracking this device. |
58
|
|
|
|
|
|
|
|
59
|
|
|
|
|
|
|
=item * |
60
|
|
|
|
|
|
|
|
61
|
|
|
|
|
|
|
C<DEVICE_PASSWORD_VERIFIER>: Similar to C<PASSWORD_VERIFIER>, but for |
62
|
|
|
|
|
|
|
devices only. |
63
|
|
|
|
|
|
|
|
64
|
|
|
|
|
|
|
=item * |
65
|
|
|
|
|
|
|
|
66
|
|
|
|
|
|
|
C<ADMIN_NO_SRP_AUTH>: This is returned if you need to authenticate with |
67
|
|
|
|
|
|
|
C<USERNAME> and C<PASSWORD> directly. An app client must be enabled to |
68
|
|
|
|
|
|
|
use this flow. |
69
|
|
|
|
|
|
|
|
70
|
|
|
|
|
|
|
=item * |
71
|
|
|
|
|
|
|
|
72
|
|
|
|
|
|
|
C<NEW_PASSWORD_REQUIRED>: For users which are required to change their |
73
|
|
|
|
|
|
|
passwords after successful first login. This challenge should be passed |
74
|
|
|
|
|
|
|
with C<NEW_PASSWORD> and any other required attributes. |
75
|
|
|
|
|
|
|
|
76
|
|
|
|
|
|
|
=back |
77
|
|
|
|
|
|
|
|
78
|
|
|
|
|
|
|
|
79
|
|
|
|
|
|
|
Valid values are: C<"SMS_MFA">, C<"PASSWORD_VERIFIER">, C<"CUSTOM_CHALLENGE">, C<"DEVICE_SRP_AUTH">, C<"DEVICE_PASSWORD_VERIFIER">, C<"ADMIN_NO_SRP_AUTH">, C<"NEW_PASSWORD_REQUIRED"> |
80
|
|
|
|
|
|
|
=head2 ChallengeParameters => L<Paws::CognitoIdp::ChallengeParametersType> |
81
|
|
|
|
|
|
|
|
82
|
|
|
|
|
|
|
The challenge parameters. These are returned to you in the |
83
|
|
|
|
|
|
|
C<AdminInitiateAuth> response if you need to pass another challenge. |
84
|
|
|
|
|
|
|
The responses in this parameter should be used to compute inputs to the |
85
|
|
|
|
|
|
|
next call (C<AdminRespondToAuthChallenge>). |
86
|
|
|
|
|
|
|
|
87
|
|
|
|
|
|
|
All challenges require C<USERNAME> and C<SECRET_HASH> (if applicable). |
88
|
|
|
|
|
|
|
|
89
|
|
|
|
|
|
|
The value of the C<USER_IF_FOR_SRP> attribute will be the user's actual |
90
|
|
|
|
|
|
|
username, not an alias (such as email address or phone number), even if |
91
|
|
|
|
|
|
|
you specified an alias in your call to C<AdminInitiateAuth>. This is |
92
|
|
|
|
|
|
|
because, in the C<AdminRespondToAuthChallenge> API |
93
|
|
|
|
|
|
|
C<ChallengeResponses>, the C<USERNAME> attribute cannot be an alias. |
94
|
|
|
|
|
|
|
|
95
|
|
|
|
|
|
|
|
96
|
|
|
|
|
|
|
=head2 Session => Str |
97
|
|
|
|
|
|
|
|
98
|
|
|
|
|
|
|
The session which should be passed both ways in challenge-response |
99
|
|
|
|
|
|
|
calls to the service. If C<AdminInitiateAuth> or |
100
|
|
|
|
|
|
|
C<AdminRespondToAuthChallenge> API call determines that the caller |
101
|
|
|
|
|
|
|
needs to go through another challenge, they return a session with other |
102
|
|
|
|
|
|
|
challenge parameters. This session should be passed as it is to the |
103
|
|
|
|
|
|
|
next C<AdminRespondToAuthChallenge> API call. |
104
|
|
|
|
|
|
|
|
105
|
|
|
|
|
|
|
|
106
|
|
|
|
|
|
|
=head2 _request_id => Str |
107
|
|
|
|
|
|
|
|
108
|
|
|
|
|
|
|
|
109
|
|
|
|
|
|
|
=cut |
110
|
|
|
|
|
|
|
|
111
|
|
|
|
|
|
|
1; |