1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package cognitoidentityprovider
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/cognitoidentityprovider/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Links an existing user account in a user pool ( DestinationUser ) to an identity
// from an external IdP ( SourceUser ) based on a specified attribute name and
// value from the external IdP. This allows you to create a link from the existing
// user account to an external federated user identity that has not yet been used
// to sign in. You can then use the federated user identity to sign in as the
// existing user account. For example, if there is an existing user with a username
// and password, this API links that user to a federated user identity. When the
// user signs in with a federated user identity, they sign in as the existing user
// account. The maximum number of federated identities linked to a user is five.
// Because this API allows a user with an external federated identity to sign in as
// an existing user in the user pool, it is critical that it only be used with
// external IdPs and provider attributes that have been trusted by the application
// owner. Amazon Cognito evaluates Identity and Access Management (IAM) policies in
// requests for this API operation. For this operation, you must use IAM
// credentials to authorize requests, and you must grant yourself the corresponding
// IAM permission in a policy. Learn more
// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)
// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)
func (c *Client) AdminLinkProviderForUser(ctx context.Context, params *AdminLinkProviderForUserInput, optFns ...func(*Options)) (*AdminLinkProviderForUserOutput, error) {
if params == nil {
params = &AdminLinkProviderForUserInput{}
}
result, metadata, err := c.invokeOperation(ctx, "AdminLinkProviderForUser", params, optFns, c.addOperationAdminLinkProviderForUserMiddlewares)
if err != nil {
return nil, err
}
out := result.(*AdminLinkProviderForUserOutput)
out.ResultMetadata = metadata
return out, nil
}
type AdminLinkProviderForUserInput struct {
// The existing user in the user pool that you want to assign to the external IdP
// user account. This user can be a local (Username + Password) Amazon Cognito user
// pools user or a federated user (for example, a SAML or Facebook user). If the
// user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito
// returns this user when the new user (with the linked IdP attribute) signs in.
// For a native username + password user, the ProviderAttributeValue for the
// DestinationUser should be the username in the user pool. For a federated user,
// it should be the provider-specific user_id . The ProviderAttributeName of the
// DestinationUser is ignored. The ProviderName should be set to Cognito for users
// in Cognito user pools. All attributes in the DestinationUser profile must be
// mutable. If you have assigned the user any immutable custom attributes, the
// operation won't succeed.
//
// This member is required.
DestinationUser *types.ProviderUserIdentifierType
// An external IdP account for a user who doesn't exist yet in the user pool. This
// user must be a federated user (for example, a SAML or Facebook user), not
// another native user. If the SourceUser is using a federated social IdP, such as
// Facebook, Google, or Login with Amazon, you must set the ProviderAttributeName
// to Cognito_Subject . For social IdPs, the ProviderName will be Facebook , Google
// , or LoginWithAmazon , and Amazon Cognito will automatically parse the Facebook,
// Google, and Login with Amazon tokens for id , sub , and user_id , respectively.
// The ProviderAttributeValue for the user must be the same value as the id , sub ,
// or user_id value found in the social IdP token. For OIDC, the
// ProviderAttributeName can be any value that matches a claim in the ID token, or
// that your app retrieves from the userInfo endpoint. You must map the claim to a
// user pool attribute in your IdP configuration, and set the user pool attribute
// name as the value of ProviderAttributeName in your AdminLinkProviderForUser
// request. For SAML, the ProviderAttributeName can be any value that matches a
// claim in the SAML assertion. To link SAML users based on the subject of the SAML
// assertion, map the subject to a claim through the SAML IdP and set that claim
// name as the value of ProviderAttributeName in your AdminLinkProviderForUser
// request. For both OIDC and SAML users, when you set ProviderAttributeName to
// Cognito_Subject , Amazon Cognito will automatically parse the default unique
// identifier found in the subject from the IdP token.
//
// This member is required.
SourceUser *types.ProviderUserIdentifierType
// The user pool ID for the user pool.
//
// This member is required.
UserPoolId *string
noSmithyDocumentSerde
}
type AdminLinkProviderForUserOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationAdminLinkProviderForUserMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpAdminLinkProviderForUser{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpAdminLinkProviderForUser{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "AdminLinkProviderForUser"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpAdminLinkProviderForUserValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opAdminLinkProviderForUser(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opAdminLinkProviderForUser(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "AdminLinkProviderForUser",
}
}
|
