Class: Aws::CognitoIdentityProvider::Types::AdminLinkProviderForUserRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::AdminLinkProviderForUserRequest
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#destination_user ⇒ Types::ProviderUserIdentifierType
The existing user in the user pool that you want to assign to the external IdP user account.
-
#source_user ⇒ Types::ProviderUserIdentifierType
An external IdP account for a user who doesn't exist yet in the user pool.
-
#user_pool_id ⇒ String
The user pool ID for the user pool.
Instance Attribute Details
#destination_user ⇒ Types::ProviderUserIdentifierType
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.
1129 1130 1131 1132 1133 1134 1135 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1129 class AdminLinkProviderForUserRequest < Struct.new( :user_pool_id, :destination_user, :source_user) SENSITIVE = [] include Aws::Structure end |
#source_user ⇒ 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.
1129 1130 1131 1132 1133 1134 1135 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1129 class AdminLinkProviderForUserRequest < Struct.new( :user_pool_id, :destination_user, :source_user) SENSITIVE = [] include Aws::Structure end |
#user_pool_id ⇒ String
The user pool ID for the user pool.
1129 1130 1131 1132 1133 1134 1135 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1129 class AdminLinkProviderForUserRequest < Struct.new( :user_pool_id, :destination_user, :source_user) SENSITIVE = [] include Aws::Structure end |