File Coverage

blib/lib/Paws/CognitoIdp/AdminLinkProviderForUser.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CognitoIdp::AdminLinkProviderForUser;
3 1     1   444 use Moose;
  1         2  
  1         6  
4             has DestinationUser => (is => 'ro', isa => 'Paws::CognitoIdp::ProviderUserIdentifierType', required => 1);
5             has SourceUser => (is => 'ro', isa => 'Paws::CognitoIdp::ProviderUserIdentifierType', required => 1);
6             has UserPoolId => (is => 'ro', isa => 'Str', required => 1);
7              
8 1     1   5998 use MooseX::ClassAttribute;
  1         2  
  1         10  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'AdminLinkProviderForUser');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::AdminLinkProviderForUserResponse');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::CognitoIdp::AdminLinkProviderForUser - Arguments for method AdminLinkProviderForUser on Paws::CognitoIdp
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method AdminLinkProviderForUser on the
24             Amazon Cognito Identity Provider service. Use the attributes of this class
25             as arguments to method AdminLinkProviderForUser.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to AdminLinkProviderForUser.
28              
29             As an example:
30              
31             $service_obj->AdminLinkProviderForUser(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 B<REQUIRED> DestinationUser => L<Paws::CognitoIdp::ProviderUserIdentifierType>
39              
40             The existing user in the user pool to be linked to the external
41             identity provider user account. Can be a native (Username + Password)
42             Cognito User Pools user or a federated user (for example, a SAML or
43             Facebook user). If the user doesn't exist, an exception is thrown. This
44             is the user that is returned when the new user (with the linked
45             identity provider attribute) signs in.
46              
47             The C<ProviderAttributeValue> for the C<DestinationUser> must match the
48             username for the user in the user pool. The C<ProviderAttributeName>
49             will always be ignored.
50              
51              
52              
53             =head2 B<REQUIRED> SourceUser => L<Paws::CognitoIdp::ProviderUserIdentifierType>
54              
55             An external identity provider account for a user who does not currently
56             exist yet in the user pool. This user must be a federated user (for
57             example, a SAML or Facebook user), not another native user.
58              
59             If the C<SourceUser> is a federated social identity provider user
60             (Facebook, Google, or Login with Amazon), you must set the
61             C<ProviderAttributeName> to C<Cognito_Subject>. For social identity
62             providers, the C<ProviderName> will be C<Facebook>, C<Google>, or
63             C<LoginWithAmazon>, and Cognito will automatically parse the Facebook,
64             Google, and Login with Amazon tokens for C<id>, C<sub>, and C<user_id>,
65             respectively. The C<ProviderAttributeValue> for the user must be the
66             same value as the C<id>, C<sub>, or C<user_id> value found in the
67             social identity provider token.
68              
69             For SAML, the C<ProviderAttributeName> can be any value that matches a
70             claim in the SAML assertion. If you wish to link SAML users based on
71             the subject of the SAML assertion, you should map the subject to a
72             claim through the SAML identity provider and submit that claim name as
73             the C<ProviderAttributeName>. If you set C<ProviderAttributeName> to
74             C<Cognito_Subject>, Cognito will automatically parse the default unique
75             identifier found in the subject from the SAML token.
76              
77              
78              
79             =head2 B<REQUIRED> UserPoolId => Str
80              
81             The user pool ID for the user pool.
82              
83              
84              
85              
86             =head1 SEE ALSO
87              
88             This class forms part of L<Paws>, documenting arguments for method AdminLinkProviderForUser in L<Paws::CognitoIdp>
89              
90             =head1 BUGS and CONTRIBUTIONS
91              
92             The source code is located here: https://github.com/pplu/aws-sdk-perl
93              
94             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
95              
96             =cut
97