AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest Class Reference

#include <AdminLinkProviderForUserRequest.h>

+ Inheritance diagram for Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest:

Public Member Functions

 AdminLinkProviderForUserRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetUserPoolId () const
 
bool UserPoolIdHasBeenSet () const
 
void SetUserPoolId (const Aws::String &value)
 
void SetUserPoolId (Aws::String &&value)
 
void SetUserPoolId (const char *value)
 
AdminLinkProviderForUserRequestWithUserPoolId (const Aws::String &value)
 
AdminLinkProviderForUserRequestWithUserPoolId (Aws::String &&value)
 
AdminLinkProviderForUserRequestWithUserPoolId (const char *value)
 
const ProviderUserIdentifierTypeGetDestinationUser () const
 
bool DestinationUserHasBeenSet () const
 
void SetDestinationUser (const ProviderUserIdentifierType &value)
 
void SetDestinationUser (ProviderUserIdentifierType &&value)
 
AdminLinkProviderForUserRequestWithDestinationUser (const ProviderUserIdentifierType &value)
 
AdminLinkProviderForUserRequestWithDestinationUser (ProviderUserIdentifierType &&value)
 
const ProviderUserIdentifierTypeGetSourceUser () const
 
bool SourceUserHasBeenSet () const
 
void SetSourceUser (const ProviderUserIdentifierType &value)
 
void SetSourceUser (ProviderUserIdentifierType &&value)
 
AdminLinkProviderForUserRequestWithSourceUser (const ProviderUserIdentifierType &value)
 
AdminLinkProviderForUserRequestWithSourceUser (ProviderUserIdentifierType &&value)
 
- Public Member Functions inherited from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest
virtual ~CognitoIdentityProviderRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file AdminLinkProviderForUserRequest.h.

Constructor & Destructor Documentation

◆ AdminLinkProviderForUserRequest()

Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::AdminLinkProviderForUserRequest ( )

Member Function Documentation

◆ DestinationUserHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::DestinationUserHasBeenSet ( ) const
inline

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.

Definition at line 107 of file AdminLinkProviderForUserRequest.h.

◆ GetDestinationUser()

const ProviderUserIdentifierType& Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::GetDestinationUser ( ) const
inline

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.

Definition at line 92 of file AdminLinkProviderForUserRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file AdminLinkProviderForUserRequest.h.

◆ GetSourceUser()

const ProviderUserIdentifierType& Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::GetSourceUser ( ) const
inline

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.

Definition at line 192 of file AdminLinkProviderForUserRequest.h.

◆ GetUserPoolId()

const Aws::String& Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::GetUserPoolId ( ) const
inline

The user pool ID for the user pool.

Definition at line 41 of file AdminLinkProviderForUserRequest.h.

◆ SerializePayload()

Aws::String Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDestinationUser() [1/2]

void Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::SetDestinationUser ( const ProviderUserIdentifierType value)
inline

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.

Definition at line 122 of file AdminLinkProviderForUserRequest.h.

◆ SetDestinationUser() [2/2]

void Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::SetDestinationUser ( ProviderUserIdentifierType &&  value)
inline

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.

Definition at line 137 of file AdminLinkProviderForUserRequest.h.

◆ SetSourceUser() [1/2]

void Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::SetSourceUser ( const ProviderUserIdentifierType value)
inline

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.

Definition at line 240 of file AdminLinkProviderForUserRequest.h.

◆ SetSourceUser() [2/2]

void Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::SetSourceUser ( ProviderUserIdentifierType &&  value)
inline

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.

Definition at line 264 of file AdminLinkProviderForUserRequest.h.

◆ SetUserPoolId() [1/3]

void Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::SetUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool.

Definition at line 56 of file AdminLinkProviderForUserRequest.h.

◆ SetUserPoolId() [2/3]

void Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::SetUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool.

Definition at line 51 of file AdminLinkProviderForUserRequest.h.

◆ SetUserPoolId() [3/3]

void Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::SetUserPoolId ( const char *  value)
inline

The user pool ID for the user pool.

Definition at line 61 of file AdminLinkProviderForUserRequest.h.

◆ SourceUserHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::SourceUserHasBeenSet ( ) const
inline

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.

Definition at line 216 of file AdminLinkProviderForUserRequest.h.

◆ UserPoolIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::UserPoolIdHasBeenSet ( ) const
inline

The user pool ID for the user pool.

Definition at line 46 of file AdminLinkProviderForUserRequest.h.

◆ WithDestinationUser() [1/2]

AdminLinkProviderForUserRequest& Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::WithDestinationUser ( const ProviderUserIdentifierType value)
inline

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.

Definition at line 152 of file AdminLinkProviderForUserRequest.h.

◆ WithDestinationUser() [2/2]

AdminLinkProviderForUserRequest& Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::WithDestinationUser ( ProviderUserIdentifierType &&  value)
inline

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.

Definition at line 167 of file AdminLinkProviderForUserRequest.h.

◆ WithSourceUser() [1/2]

AdminLinkProviderForUserRequest& Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::WithSourceUser ( const ProviderUserIdentifierType value)
inline

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.

Definition at line 288 of file AdminLinkProviderForUserRequest.h.

◆ WithSourceUser() [2/2]

AdminLinkProviderForUserRequest& Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::WithSourceUser ( ProviderUserIdentifierType &&  value)
inline

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.

Definition at line 312 of file AdminLinkProviderForUserRequest.h.

◆ WithUserPoolId() [1/3]

AdminLinkProviderForUserRequest& Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::WithUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool.

Definition at line 71 of file AdminLinkProviderForUserRequest.h.

◆ WithUserPoolId() [2/3]

AdminLinkProviderForUserRequest& Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::WithUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool.

Definition at line 66 of file AdminLinkProviderForUserRequest.h.

◆ WithUserPoolId() [3/3]

AdminLinkProviderForUserRequest& Aws::CognitoIdentityProvider::Model::AdminLinkProviderForUserRequest::WithUserPoolId ( const char *  value)
inline

The user pool ID for the user pool.

Definition at line 76 of file AdminLinkProviderForUserRequest.h.


The documentation for this class was generated from the following file: