/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace CognitoIdentityProvider { namespace Model { /** *

Represents the response from the server from the request to get the specified * user as an administrator.

See Also:

AWS * API Reference

*/ class AWS_COGNITOIDENTITYPROVIDER_API AdminGetUserResult { public: AdminGetUserResult(); AdminGetUserResult(const Aws::AmazonWebServiceResult& result); AdminGetUserResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The user name of the user about whom you are receiving information.

*/ inline const Aws::String& GetUsername() const{ return m_username; } /** *

The user name of the user about whom you are receiving information.

*/ inline void SetUsername(const Aws::String& value) { m_username = value; } /** *

The user name of the user about whom you are receiving information.

*/ inline void SetUsername(Aws::String&& value) { m_username = std::move(value); } /** *

The user name of the user about whom you are receiving information.

*/ inline void SetUsername(const char* value) { m_username.assign(value); } /** *

The user name of the user about whom you are receiving information.

*/ inline AdminGetUserResult& WithUsername(const Aws::String& value) { SetUsername(value); return *this;} /** *

The user name of the user about whom you are receiving information.

*/ inline AdminGetUserResult& WithUsername(Aws::String&& value) { SetUsername(std::move(value)); return *this;} /** *

The user name of the user about whom you are receiving information.

*/ inline AdminGetUserResult& WithUsername(const char* value) { SetUsername(value); return *this;} /** *

An array of name-value pairs representing user attributes.

*/ inline const Aws::Vector& GetUserAttributes() const{ return m_userAttributes; } /** *

An array of name-value pairs representing user attributes.

*/ inline void SetUserAttributes(const Aws::Vector& value) { m_userAttributes = value; } /** *

An array of name-value pairs representing user attributes.

*/ inline void SetUserAttributes(Aws::Vector&& value) { m_userAttributes = std::move(value); } /** *

An array of name-value pairs representing user attributes.

*/ inline AdminGetUserResult& WithUserAttributes(const Aws::Vector& value) { SetUserAttributes(value); return *this;} /** *

An array of name-value pairs representing user attributes.

*/ inline AdminGetUserResult& WithUserAttributes(Aws::Vector&& value) { SetUserAttributes(std::move(value)); return *this;} /** *

An array of name-value pairs representing user attributes.

*/ inline AdminGetUserResult& AddUserAttributes(const AttributeType& value) { m_userAttributes.push_back(value); return *this; } /** *

An array of name-value pairs representing user attributes.

*/ inline AdminGetUserResult& AddUserAttributes(AttributeType&& value) { m_userAttributes.push_back(std::move(value)); return *this; } /** *

The date the user was created.

*/ inline const Aws::Utils::DateTime& GetUserCreateDate() const{ return m_userCreateDate; } /** *

The date the user was created.

*/ inline void SetUserCreateDate(const Aws::Utils::DateTime& value) { m_userCreateDate = value; } /** *

The date the user was created.

*/ inline void SetUserCreateDate(Aws::Utils::DateTime&& value) { m_userCreateDate = std::move(value); } /** *

The date the user was created.

*/ inline AdminGetUserResult& WithUserCreateDate(const Aws::Utils::DateTime& value) { SetUserCreateDate(value); return *this;} /** *

The date the user was created.

*/ inline AdminGetUserResult& WithUserCreateDate(Aws::Utils::DateTime&& value) { SetUserCreateDate(std::move(value)); return *this;} /** *

The date the user was last modified.

*/ inline const Aws::Utils::DateTime& GetUserLastModifiedDate() const{ return m_userLastModifiedDate; } /** *

The date the user was last modified.

*/ inline void SetUserLastModifiedDate(const Aws::Utils::DateTime& value) { m_userLastModifiedDate = value; } /** *

The date the user was last modified.

*/ inline void SetUserLastModifiedDate(Aws::Utils::DateTime&& value) { m_userLastModifiedDate = std::move(value); } /** *

The date the user was last modified.

*/ inline AdminGetUserResult& WithUserLastModifiedDate(const Aws::Utils::DateTime& value) { SetUserLastModifiedDate(value); return *this;} /** *

The date the user was last modified.

*/ inline AdminGetUserResult& WithUserLastModifiedDate(Aws::Utils::DateTime&& value) { SetUserLastModifiedDate(std::move(value)); return *this;} /** *

Indicates that the status is enabled.

*/ inline bool GetEnabled() const{ return m_enabled; } /** *

Indicates that the status is enabled.

*/ inline void SetEnabled(bool value) { m_enabled = value; } /** *

Indicates that the status is enabled.

*/ inline AdminGetUserResult& WithEnabled(bool value) { SetEnabled(value); return *this;} /** *

The user status. Can be one of the following:

  • UNCONFIRMED - * User has been created but not confirmed.

  • CONFIRMED - User has * been confirmed.

  • ARCHIVED - User is no longer active.

  • *
  • COMPROMISED - User is disabled due to a potential security threat.

    *
  • UNKNOWN - User status is not known.

  • *

    RESET_REQUIRED - User is confirmed, but the user must request a code and * reset his or her password before he or she can sign in.

  • *

    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using * a temporary password, but on first sign-in, the user must change his or her * password to a new value before doing anything else.

*/ inline const UserStatusType& GetUserStatus() const{ return m_userStatus; } /** *

The user status. Can be one of the following:

  • UNCONFIRMED - * User has been created but not confirmed.

  • CONFIRMED - User has * been confirmed.

  • ARCHIVED - User is no longer active.

  • *
  • COMPROMISED - User is disabled due to a potential security threat.

    *
  • UNKNOWN - User status is not known.

  • *

    RESET_REQUIRED - User is confirmed, but the user must request a code and * reset his or her password before he or she can sign in.

  • *

    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using * a temporary password, but on first sign-in, the user must change his or her * password to a new value before doing anything else.

*/ inline void SetUserStatus(const UserStatusType& value) { m_userStatus = value; } /** *

The user status. Can be one of the following:

  • UNCONFIRMED - * User has been created but not confirmed.

  • CONFIRMED - User has * been confirmed.

  • ARCHIVED - User is no longer active.

  • *
  • COMPROMISED - User is disabled due to a potential security threat.

    *
  • UNKNOWN - User status is not known.

  • *

    RESET_REQUIRED - User is confirmed, but the user must request a code and * reset his or her password before he or she can sign in.

  • *

    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using * a temporary password, but on first sign-in, the user must change his or her * password to a new value before doing anything else.

*/ inline void SetUserStatus(UserStatusType&& value) { m_userStatus = std::move(value); } /** *

The user status. Can be one of the following:

  • UNCONFIRMED - * User has been created but not confirmed.

  • CONFIRMED - User has * been confirmed.

  • ARCHIVED - User is no longer active.

  • *
  • COMPROMISED - User is disabled due to a potential security threat.

    *
  • UNKNOWN - User status is not known.

  • *

    RESET_REQUIRED - User is confirmed, but the user must request a code and * reset his or her password before he or she can sign in.

  • *

    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using * a temporary password, but on first sign-in, the user must change his or her * password to a new value before doing anything else.

*/ inline AdminGetUserResult& WithUserStatus(const UserStatusType& value) { SetUserStatus(value); return *this;} /** *

The user status. Can be one of the following:

  • UNCONFIRMED - * User has been created but not confirmed.

  • CONFIRMED - User has * been confirmed.

  • ARCHIVED - User is no longer active.

  • *
  • COMPROMISED - User is disabled due to a potential security threat.

    *
  • UNKNOWN - User status is not known.

  • *

    RESET_REQUIRED - User is confirmed, but the user must request a code and * reset his or her password before he or she can sign in.

  • *

    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using * a temporary password, but on first sign-in, the user must change his or her * password to a new value before doing anything else.

*/ inline AdminGetUserResult& WithUserStatus(UserStatusType&& value) { SetUserStatus(std::move(value)); return *this;} /** *

This response parameter is no longer supported. It provides * information only about SMS MFA configurations. It doesn't provide information * about TOTP software token MFA configurations. To look up information about * either type of MFA configuration, use UserMFASettingList instead.

*/ inline const Aws::Vector& GetMFAOptions() const{ return m_mFAOptions; } /** *

This response parameter is no longer supported. It provides * information only about SMS MFA configurations. It doesn't provide information * about TOTP software token MFA configurations. To look up information about * either type of MFA configuration, use UserMFASettingList instead.

*/ inline void SetMFAOptions(const Aws::Vector& value) { m_mFAOptions = value; } /** *

This response parameter is no longer supported. It provides * information only about SMS MFA configurations. It doesn't provide information * about TOTP software token MFA configurations. To look up information about * either type of MFA configuration, use UserMFASettingList instead.

*/ inline void SetMFAOptions(Aws::Vector&& value) { m_mFAOptions = std::move(value); } /** *

This response parameter is no longer supported. It provides * information only about SMS MFA configurations. It doesn't provide information * about TOTP software token MFA configurations. To look up information about * either type of MFA configuration, use UserMFASettingList instead.

*/ inline AdminGetUserResult& WithMFAOptions(const Aws::Vector& value) { SetMFAOptions(value); return *this;} /** *

This response parameter is no longer supported. It provides * information only about SMS MFA configurations. It doesn't provide information * about TOTP software token MFA configurations. To look up information about * either type of MFA configuration, use UserMFASettingList instead.

*/ inline AdminGetUserResult& WithMFAOptions(Aws::Vector&& value) { SetMFAOptions(std::move(value)); return *this;} /** *

This response parameter is no longer supported. It provides * information only about SMS MFA configurations. It doesn't provide information * about TOTP software token MFA configurations. To look up information about * either type of MFA configuration, use UserMFASettingList instead.

*/ inline AdminGetUserResult& AddMFAOptions(const MFAOptionType& value) { m_mFAOptions.push_back(value); return *this; } /** *

This response parameter is no longer supported. It provides * information only about SMS MFA configurations. It doesn't provide information * about TOTP software token MFA configurations. To look up information about * either type of MFA configuration, use UserMFASettingList instead.

*/ inline AdminGetUserResult& AddMFAOptions(MFAOptionType&& value) { m_mFAOptions.push_back(std::move(value)); return *this; } /** *

The user's preferred MFA setting.

*/ inline const Aws::String& GetPreferredMfaSetting() const{ return m_preferredMfaSetting; } /** *

The user's preferred MFA setting.

*/ inline void SetPreferredMfaSetting(const Aws::String& value) { m_preferredMfaSetting = value; } /** *

The user's preferred MFA setting.

*/ inline void SetPreferredMfaSetting(Aws::String&& value) { m_preferredMfaSetting = std::move(value); } /** *

The user's preferred MFA setting.

*/ inline void SetPreferredMfaSetting(const char* value) { m_preferredMfaSetting.assign(value); } /** *

The user's preferred MFA setting.

*/ inline AdminGetUserResult& WithPreferredMfaSetting(const Aws::String& value) { SetPreferredMfaSetting(value); return *this;} /** *

The user's preferred MFA setting.

*/ inline AdminGetUserResult& WithPreferredMfaSetting(Aws::String&& value) { SetPreferredMfaSetting(std::move(value)); return *this;} /** *

The user's preferred MFA setting.

*/ inline AdminGetUserResult& WithPreferredMfaSetting(const char* value) { SetPreferredMfaSetting(value); return *this;} /** *

The MFA options that are enabled for the user. The possible values in this * list are SMS_MFA and SOFTWARE_TOKEN_MFA.

*/ inline const Aws::Vector& GetUserMFASettingList() const{ return m_userMFASettingList; } /** *

The MFA options that are enabled for the user. The possible values in this * list are SMS_MFA and SOFTWARE_TOKEN_MFA.

*/ inline void SetUserMFASettingList(const Aws::Vector& value) { m_userMFASettingList = value; } /** *

The MFA options that are enabled for the user. The possible values in this * list are SMS_MFA and SOFTWARE_TOKEN_MFA.

*/ inline void SetUserMFASettingList(Aws::Vector&& value) { m_userMFASettingList = std::move(value); } /** *

The MFA options that are enabled for the user. The possible values in this * list are SMS_MFA and SOFTWARE_TOKEN_MFA.

*/ inline AdminGetUserResult& WithUserMFASettingList(const Aws::Vector& value) { SetUserMFASettingList(value); return *this;} /** *

The MFA options that are enabled for the user. The possible values in this * list are SMS_MFA and SOFTWARE_TOKEN_MFA.

*/ inline AdminGetUserResult& WithUserMFASettingList(Aws::Vector&& value) { SetUserMFASettingList(std::move(value)); return *this;} /** *

The MFA options that are enabled for the user. The possible values in this * list are SMS_MFA and SOFTWARE_TOKEN_MFA.

*/ inline AdminGetUserResult& AddUserMFASettingList(const Aws::String& value) { m_userMFASettingList.push_back(value); return *this; } /** *

The MFA options that are enabled for the user. The possible values in this * list are SMS_MFA and SOFTWARE_TOKEN_MFA.

*/ inline AdminGetUserResult& AddUserMFASettingList(Aws::String&& value) { m_userMFASettingList.push_back(std::move(value)); return *this; } /** *

The MFA options that are enabled for the user. The possible values in this * list are SMS_MFA and SOFTWARE_TOKEN_MFA.

*/ inline AdminGetUserResult& AddUserMFASettingList(const char* value) { m_userMFASettingList.push_back(value); return *this; } private: Aws::String m_username; Aws::Vector m_userAttributes; Aws::Utils::DateTime m_userCreateDate; Aws::Utils::DateTime m_userLastModifiedDate; bool m_enabled; UserStatusType m_userStatus; Aws::Vector m_mFAOptions; Aws::String m_preferredMfaSetting; Aws::Vector m_userMFASettingList; }; } // namespace Model } // namespace CognitoIdentityProvider } // namespace Aws