Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface AdminGetUserResponse.Builder

    • Method Detail

      • username

        AdminGetUserResponse.Builder username​(String username)

        The username of the user that you requested.

        Parameters:
        username - The username of the user that you requested.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userAttributes

        AdminGetUserResponse.Builder userAttributes​(Collection<AttributeType> userAttributes)

        An array of name-value pairs of user attributes and their values, for example "email": "testuser@example.com".

        Parameters:
        userAttributes - An array of name-value pairs of user attributes and their values, for example "email": "testuser@example.com".
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userAttributes

        AdminGetUserResponse.Builder userAttributes​(AttributeType... userAttributes)

        An array of name-value pairs of user attributes and their values, for example "email": "testuser@example.com".

        Parameters:
        userAttributes - An array of name-value pairs of user attributes and their values, for example "email": "testuser@example.com".
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userCreateDate

        AdminGetUserResponse.Builder userCreateDate​(Instant userCreateDate)

        The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

        Parameters:
        userCreateDate - The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userLastModifiedDate

        AdminGetUserResponse.Builder userLastModifiedDate​(Instant userLastModifiedDate)

        The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

        Parameters:
        userLastModifiedDate - The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enabled

        AdminGetUserResponse.Builder enabled​(Boolean enabled)

        Indicates whether the user is activated for sign-in. The AdminDisableUser and AdminEnableUser API operations deactivate and activate user sign-in, respectively.

        Parameters:
        enabled - Indicates whether the user is activated for sign-in. The AdminDisableUser and AdminEnableUser API operations deactivate and activate user sign-in, respectively.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userStatus

        AdminGetUserResponse.Builder userStatus​(String userStatus)

        The user's status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.

        • CONFIRMED - User has been confirmed.

        • UNKNOWN - User status isn't known.

        • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.

        • EXTERNAL_PROVIDER - The user signed in with a third-party identity provider.

        Parameters:
        userStatus - The user's status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.

        • CONFIRMED - User has been confirmed.

        • UNKNOWN - User status isn't known.

        • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.

        • EXTERNAL_PROVIDER - The user signed in with a third-party identity provider.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UserStatusType, UserStatusType

      • userStatus

        AdminGetUserResponse.Builder userStatus​(UserStatusType userStatus)

        The user's status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.

        • CONFIRMED - User has been confirmed.

        • UNKNOWN - User status isn't known.

        • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.

        • EXTERNAL_PROVIDER - The user signed in with a third-party identity provider.

        Parameters:
        userStatus - The user's status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.

        • CONFIRMED - User has been confirmed.

        • UNKNOWN - User status isn't known.

        • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.

        • EXTERNAL_PROVIDER - The user signed in with a third-party identity provider.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UserStatusType, UserStatusType

      • mfaOptions

        AdminGetUserResponse.Builder mfaOptions​(Collection<MFAOptionType> mfaOptions)

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

        Parameters:
        mfaOptions - This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mfaOptions

        AdminGetUserResponse.Builder mfaOptions​(MFAOptionType... mfaOptions)

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

        Parameters:
        mfaOptions - This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mfaOptions

        AdminGetUserResponse.Builder mfaOptions​(Consumer<MFAOptionType.Builder>... mfaOptions)

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

        This is a convenience method that creates an instance of the MFAOptionType.Builder avoiding the need to create one manually via MFAOptionType.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #mfaOptions(List).

        Parameters:
        mfaOptions - a consumer that will call methods on MFAOptionType.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #mfaOptions(java.util.Collection)

      • preferredMfaSetting

        AdminGetUserResponse.Builder preferredMfaSetting​(String preferredMfaSetting)

        The user's preferred MFA. Users can prefer SMS message, email message, or TOTP MFA.

        Parameters:
        preferredMfaSetting - The user's preferred MFA. Users can prefer SMS message, email message, or TOTP MFA.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userMFASettingList

        AdminGetUserResponse.Builder userMFASettingList​(Collection<String> userMFASettingList)

        The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA. You can change the MFA preference for users who have more than one available MFA factor with AdminSetUserMFAPreference or SetUserMFAPreference.

        Parameters:
        userMFASettingList - The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA. You can change the MFA preference for users who have more than one available MFA factor with AdminSetUserMFAPreference or SetUserMFAPreference.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userMFASettingList

        AdminGetUserResponse.Builder userMFASettingList​(String... userMFASettingList)

        The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA. You can change the MFA preference for users who have more than one available MFA factor with AdminSetUserMFAPreference or SetUserMFAPreference.

        Parameters:
        userMFASettingList - The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA. You can change the MFA preference for users who have more than one available MFA factor with AdminSetUserMFAPreference or SetUserMFAPreference.
        Returns:
        Returns a reference to this object so that method calls can be chained together.