Interface ICognitoIdentityProvider

Namespace: Innovt.Cloud.AWS.Cognito

Assembly: Innovt.Cloud.AWS.Cognito.dll

Syntax

public interface ICognitoIdentityProvider

Methods

ChangePassword(ChangePasswordRequest, CancellationToken)

Change the password for an authenticated user.

Declaration

Task ChangePassword(ChangePasswordRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ChangePasswordRequest	command	The request object containing the necessary information to change the user's password.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task

ClearSocialAccounts(ClearSocialAccountRequest, CancellationToken)

Clear all social accounts for a confirmed user. You can Use this method to remove social accounts that you want to merge or delete from the user pool. This method will remove all social accounts linked to the user, but will not delete the user account itself.

Declaration

Task<bool> ClearSocialAccounts(ClearSocialAccountRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ClearSocialAccountRequest	command	A command with the cognito username. It can not be social account. Must be non federated account.
CancellationToken	cancellationToken

Returns

Type	Description
Task<bool>

ConfirmForgotPassword(ConfirmForgotPasswordRequest, CancellationToken)

Confirm a forgot password request and set a new password for the user.

Declaration

Task ConfirmForgotPassword(ConfirmForgotPasswordRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ConfirmForgotPasswordRequest	command	The request object containing the confirmation details.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task

ConfirmSignUp(ConfirmSignUpRequest, CancellationToken)

Confirm a user's sign-up by verifying the confirmation code.

Declaration

Task ConfirmSignUp(ConfirmSignUpRequest request, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ConfirmSignUpRequest	request	The request object containing the user's sign-up confirmation details.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task

DeleteUser(DeleteUserAccountRequest, CancellationToken)

This method allow you to delete a user account from the user pool.

Declaration

Task<bool> DeleteUser(DeleteUserAccountRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DeleteUserAccountRequest	command
CancellationToken	cancellationToken

Returns

Type	Description
Task<bool>

ForgotPassword(ForgotPasswordRequest, CancellationToken)

Initiate a forgot password request for a user.

Declaration

Task ForgotPassword(ForgotPasswordRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ForgotPasswordRequest	command	The request object containing the user's information.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task

GetUser<T>(GetUserRequest, CancellationToken)

Retrieve user information based on the specified request.

Declaration

Task<T> GetUser<T>(GetUserRequest request, CancellationToken cancellationToken = default) where T : IGetUserResponse

Parameters

Type	Name	Description
GetUserRequest	request	The request object containing the criteria to retrieve user information.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task<T>	The response object containing user information.

Type Parameters

Name	Description
T	The response object type containing user information. Must implement the IGetUserResponse interface.

GetUser<T>(string, CancellationToken)

Retrieve user information based on the access token.

Declaration

Task<T> GetUser<T>(string accessToken, CancellationToken cancellationToken = default) where T : IGetUserResponse

Parameters

Type	Name	Description
string	accessToken	A valid access token.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task<T>	The response object containing user information.

Type Parameters

Name	Description
T	The response object type containing user information. Must implement the IGetUserResponse interface.

LinkSocialUser(LinkSocialAccountRequest, CancellationToken)

Link existent user account with a social user account to avoid billing issues and other problems.

Declaration

Task<bool> LinkSocialUser(LinkSocialAccountRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
LinkSocialAccountRequest	command	The request object containing the user pool and email from user.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task<bool>

RefreshToken(RefreshTokenRequest, CancellationToken)

Refresh the user's authentication token.

Declaration

Task<RefreshTokenResponse> RefreshToken(RefreshTokenRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RefreshTokenRequest	command	The request object containing the refresh token.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task<RefreshTokenResponse>	The response object containing the refreshed authentication token.

ResendConfirmationCode(ResendConfirmationCodeRequest, CancellationToken)

Resend a confirmation code to the user's email or phone number.

Declaration

Task ResendConfirmationCode(ResendConfirmationCodeRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ResendConfirmationCodeRequest	command	The request object containing the user's information.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task

RespondToAuthChallenge(RespondToAuthChallengeRequest, CancellationToken)

Respond to an authentication challenge during the sign-in process.

Declaration

Task<AuthChallengeResponse> RespondToAuthChallenge(RespondToAuthChallengeRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RespondToAuthChallengeRequest	command	The request object containing the challenge response.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task<AuthChallengeResponse>	The response object containing the result of the authentication challenge.

SignIn(OtpSignInRequest, CancellationToken)

Authenticate a user using one-time password (OTP) credentials.

Declaration

Task<SignInResponse> SignIn(OtpSignInRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OtpSignInRequest	command	The request object containing the OTP credentials.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task<SignInResponse>	The response object containing the authentication result.

SignIn(SignInRequest, CancellationToken)

Authenticate a user using standard credentials (username and password).

Declaration

Task<SignInResponse> SignIn(SignInRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SignInRequest	command	The request object containing the standard sign-in credentials.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task<SignInResponse>	The response object containing the authentication result.

SignOut(SignOutRequest, CancellationToken)

Sign a user out of the application.

Declaration

Task SignOut(SignOutRequest request, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SignOutRequest	request	The request object containing the access token.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task

SignUp(ISignUpRequest, CancellationToken)

Sign up a new user.

Declaration

Task<SignUpResponse> SignUp(ISignUpRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ISignUpRequest	command	The request object containing the user's sign-up details.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task<SignUpResponse>	The response object containing the sign-up confirmation details.

SocialSignIn(SocialSignInRequest, CancellationToken)

Authenticate a user using social media credentials.

Declaration

Task<OAuth2SignInResponse> SocialSignIn(SocialSignInRequest command, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SocialSignInRequest	command	The request object containing the social media sign-in credentials.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task<OAuth2SignInResponse>	The response object containing the social media sign-in result.

UpdateUserAttributes(AdminUpdateUserAttributesRequest, CancellationToken)

This method allow you to update user attributes without sending a token. Internally we are calling Admin Update User Attributes.

Declaration

Task UpdateUserAttributes(AdminUpdateUserAttributesRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AdminUpdateUserAttributesRequest	command
CancellationToken	cancellationToken

Returns

Type	Description
Task

UpdateUserAttributes(UpdateUserAttributesRequest, CancellationToken)

Update user attributes with new values.

Declaration

Task UpdateUserAttributes(UpdateUserAttributesRequest command, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateUserAttributesRequest	command	The request object containing the updated user attributes.
CancellationToken	cancellationToken	A token to cancel the operation if needed.

Returns

Type	Description
Task

Extension Methods

Extensions.IsNull(object)

Extensions.ToStringOrDefault(object)

SimpleMapper.MapTo<T1>(object)