AdminGetUserResponse

import type { AdminGetUserResponse } from "https://aws-api.deno.dev/v0.3/services/cognitoidentityserviceprovider.ts?docs=full";

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

interface AdminGetUserResponse {

Enabled?: boolean | null;

MFAOptions?: MFAOptionType[] | null;

PreferredMfaSetting?: string | null;

UserAttributes?: AttributeType[] | null;

UserCreateDate?: Date | number | null;

UserLastModifiedDate?: Date | number | null;

UserMFASettingList?: string[] | null;

Username: string;

UserStatus?: UserStatusType | null;

}

§Properties

Enabled?: boolean | null

[src]

Indicates that the status is enabled.

MFAOptions?: MFAOptionType[] | null

[src]

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.

PreferredMfaSetting?: string | null

[src]

The user's preferred MFA setting.

UserAttributes?: AttributeType[] | null

[src]

An array of name-value pairs representing user attributes.

UserCreateDate?: Date | number | null

[src]

The date the user was created.

UserLastModifiedDate?: Date | number | null

[src]

The date the user was last modified.

UserMFASettingList?: string[] | null

[src]

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

Username: string

[src]

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

UserStatus?: UserStatusType | null

[src]

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.