@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 that you want to assign to the external identity provider user account.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends AdminLinkProviderForUserRequest.Builder> |
serializableBuilderClass() |
ProviderUserIdentifierType |
sourceUser()
An external identity provider account for a user who doesn't exist yet in the user pool.
|
AdminLinkProviderForUserRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
userPoolId()
The user pool ID for the user pool.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String userPoolId()
The user pool ID for the user pool.
public final ProviderUserIdentifierType destinationUser()
The existing user in the user pool that you want to assign to the external identity provider user account. This user can be a native (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 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.
All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.
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.
public final ProviderUserIdentifierType sourceUser()
An external identity provider 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 identity provider, such as 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 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 identity provider token.
For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If
you want 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, Amazon Cognito will automatically parse
the default unique identifier found in the subject from the SAML token.
If the SourceUser is using a federated social identity provider, such as 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 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
identity provider token.
For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML
assertion. If you want 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, Amazon Cognito will automatically parse the default unique identifier found
in the subject from the SAML token.
public AdminLinkProviderForUserRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<AdminLinkProviderForUserRequest.Builder,AdminLinkProviderForUserRequest>toBuilder in class CognitoIdentityProviderRequestpublic static AdminLinkProviderForUserRequest.Builder builder()
public static Class<? extends AdminLinkProviderForUserRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.