AWSCognitoIdentityProviderAdminLinkProviderForUserRequest
Objective-C
@interface AWSCognitoIdentityProviderAdminLinkProviderForUserRequest
Swift
class AWSCognitoIdentityProviderAdminLinkProviderForUserRequest
-
The existing user in the user pool to be linked to the external identity provider user account. Can be a native (Username + Password) Cognito User Pools user or a federated user (for example, a SAML or Facebook user). If the user doesn’t exist, an exception is thrown. This is the user that is returned when the new user (with the linked identity provider attribute) signs in.
For a native username + password user, the
ProviderAttributeValue
for theDestinationUser
should be the username in the user pool. For a federated user, it should be the provider-specificuser_id
.The
ProviderAttributeName
of theDestinationUser
is ignored.The
ProviderName
should be set toCognito
for users in Cognito user pools.Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderProviderUserIdentifierType *_Nullable destinationUser;
Swift
var destinationUser: AWSCognitoIdentityProviderProviderUserIdentifierType? { get set }
-
An external identity provider account for a user who does not currently 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 a federated social identity provider user (Facebook, Google, or Login with Amazon), you must set theProviderAttributeName
toCognito_Subject
. For social identity providers, theProviderName
will beFacebook
,Google
, orLoginWithAmazon
, and Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens forid
,sub
, anduser_id
, respectively. TheProviderAttributeValue
for the user must be the same value as theid
,sub
, oruser_id
value found in the social identity provider token.For SAML, the
ProviderAttributeName
can be any value that matches a claim in the SAML assertion. If you wish to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML identity provider and submit that claim name as theProviderAttributeName
. If you setProviderAttributeName
toCognito_Subject
, Cognito will automatically parse the default unique identifier found in the subject from the SAML token.Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderProviderUserIdentifierType *_Nullable sourceUser;
Swift
var sourceUser: AWSCognitoIdentityProviderProviderUserIdentifierType? { get set }
-
The user pool ID for the user pool.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable userPoolId;
Swift
var userPoolId: String? { get set }