public static interface AdminLinkProviderForUserRequest.Builder extends CognitoIdentityProviderRequest.Builder, CopyableBuilder<AdminLinkProviderForUserRequest.Builder,AdminLinkProviderForUserRequest>
Modifier and Type | Method and Description |
---|---|
default AdminLinkProviderForUserRequest.Builder |
destinationUser(Consumer<ProviderUserIdentifierType.Builder> destinationUser)
The existing user in the user pool to be linked to the external identity provider user account.
|
AdminLinkProviderForUserRequest.Builder |
destinationUser(ProviderUserIdentifierType destinationUser)
The existing user in the user pool to be linked to the external identity provider user account.
|
AdminLinkProviderForUserRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
AdminLinkProviderForUserRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
default AdminLinkProviderForUserRequest.Builder |
sourceUser(Consumer<ProviderUserIdentifierType.Builder> sourceUser)
An external identity provider account for a user who does not currently exist yet in the user pool.
|
AdminLinkProviderForUserRequest.Builder |
sourceUser(ProviderUserIdentifierType sourceUser)
An external identity provider account for a user who does not currently exist yet in the user pool.
|
AdminLinkProviderForUserRequest.Builder |
userPoolId(String userPoolId)
The user pool ID for the user pool.
|
build
overrideConfiguration
copy
applyMutation, build
AdminLinkProviderForUserRequest.Builder userPoolId(String userPoolId)
The user pool ID for the user pool.
userPoolId
- The user pool ID for the user pool.AdminLinkProviderForUserRequest.Builder destinationUser(ProviderUserIdentifierType destinationUser)
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.
The ProviderAttributeValue
for the DestinationUser
must match the username for the
user in the user pool. The ProviderAttributeName
will always be ignored.
destinationUser
- 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.
The ProviderAttributeValue
for the DestinationUser
must match the username
for the user in the user pool. The ProviderAttributeName
will always be ignored.
default AdminLinkProviderForUserRequest.Builder destinationUser(Consumer<ProviderUserIdentifierType.Builder> destinationUser)
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.
The ProviderAttributeValue
for the DestinationUser
must match the username for the
user in the user pool. The ProviderAttributeName
will always be ignored.
ProviderUserIdentifierType.Builder
avoiding the
need to create one manually via ProviderUserIdentifierType.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately
and its result is passed to destinationUser(ProviderUserIdentifierType)
.destinationUser
- a consumer that will call methods on ProviderUserIdentifierType.Builder
destinationUser(ProviderUserIdentifierType)
AdminLinkProviderForUserRequest.Builder sourceUser(ProviderUserIdentifierType sourceUser)
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 the ProviderAttributeName
to Cognito_Subject
. For social
identity providers, the ProviderName
will be Facebook
, Google
, or
LoginWithAmazon
, and 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 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 the ProviderAttributeName
. If you set ProviderAttributeName
to Cognito_Subject
, Cognito will automatically
parse the default unique identifier found in the subject from the SAML token.
sourceUser
- 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 the ProviderAttributeName
to
Cognito_Subject
. For social identity providers, the ProviderName
will be
Facebook
, Google
, or LoginWithAmazon
, and 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 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 the
ProviderAttributeName
. If you set ProviderAttributeName
to
Cognito_Subject
, Cognito will automatically parse the default unique identifier found in
the subject from the SAML token.
default AdminLinkProviderForUserRequest.Builder sourceUser(Consumer<ProviderUserIdentifierType.Builder> sourceUser)
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 the ProviderAttributeName
to Cognito_Subject
. For social
identity providers, the ProviderName
will be Facebook
, Google
, or
LoginWithAmazon
, and 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 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 the ProviderAttributeName
. If you set ProviderAttributeName
to Cognito_Subject
, Cognito will automatically
parse the default unique identifier found in the subject from the SAML token.
ProviderUserIdentifierType.Builder
avoiding the
need to create one manually via ProviderUserIdentifierType.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately
and its result is passed to sourceUser(ProviderUserIdentifierType)
.sourceUser
- a consumer that will call methods on ProviderUserIdentifierType.Builder
sourceUser(ProviderUserIdentifierType)
AdminLinkProviderForUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.AdminLinkProviderForUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.