@Generated(value="software.amazon.awssdk:codegen") public final class AdminLinkProviderForUserRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<AdminLinkProviderForUserRequest.Builder,AdminLinkProviderForUserRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
AdminLinkProviderForUserRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static AdminLinkProviderForUserRequest.Builder |
builder() |
ProviderUserIdentifierType |
destinationUser()
The existing user in the user pool to be linked to the external identity provider user account.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends AdminLinkProviderForUserRequest.Builder> |
serializableBuilderClass() |
ProviderUserIdentifierType |
sourceUser()
An external identity provider account for a user who does not currently exist yet in the user pool.
|
AdminLinkProviderForUserRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
userPoolId()
The user pool ID for the user pool.
|
overrideConfigurationcopypublic String userPoolId()
The user pool ID for the user pool.
public 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.
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.
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.
public 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.
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.
public AdminLinkProviderForUserRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<AdminLinkProviderForUserRequest.Builder,AdminLinkProviderForUserRequest>toBuilder in class CognitoIdentityProviderRequestpublic static AdminLinkProviderForUserRequest.Builder builder()
public static Class<? extends AdminLinkProviderForUserRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.