@datafire/amazonaws_cognito_idp

Client library for Amazon Cognito Identity Provider

Installation and Usage

npm install --save @datafire/amazonaws_cognito_idp

let amazonaws_cognito_idp = require('@datafire/amazonaws_cognito_idp').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_cognito_idp.AddCustomAttributes({
  "UserPoolId": "",
  "CustomAttributes": []
}).then(data => {
  console.log(data);
});

Description

Actions

AddCustomAttributes

amazonaws_cognito_idp.AddCustomAttributes({
  "UserPoolId": "",
  "CustomAttributes": []
}, context)

Input

• input object
  • CustomAttributes required CustomAttributesListType
  • UserPoolId required UserPoolIdType

Output

• output AddCustomAttributesResponse

AdminAddUserToGroup

amazonaws_cognito_idp.AdminAddUserToGroup({
  "UserPoolId": "",
  "Username": "",
  "GroupName": ""
}, context)

Input

• input object
  • GroupName required GroupNameType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

Output schema unknown

AdminConfirmSignUp

amazonaws_cognito_idp.AdminConfirmSignUp({
  "UserPoolId": "",
  "Username": ""
}, context)

Input

• input object
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminConfirmSignUpResponse

AdminCreateUser

amazonaws_cognito_idp.AdminCreateUser({
  "UserPoolId": "",
  "Username": ""
}, context)

Input

• input object
  • DesiredDeliveryMediums DeliveryMediumListType
  • ForceAliasCreation ForceAliasCreation
  • MessageAction MessageActionType
  • TemporaryPassword PasswordType
  • UserAttributes AttributeListType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType
  • ValidationData AttributeListType

Output

• output AdminCreateUserResponse

AdminDeleteUser

amazonaws_cognito_idp.AdminDeleteUser({
  "UserPoolId": "",
  "Username": ""
}, context)

Input

• input object
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

Output schema unknown

AdminDeleteUserAttributes

amazonaws_cognito_idp.AdminDeleteUserAttributes({
  "UserPoolId": "",
  "Username": "",
  "UserAttributeNames": []
}, context)

Input

• input object
  • UserAttributeNames required AttributeNameListType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminDeleteUserAttributesResponse

AdminDisableProviderForUser

amazonaws_cognito_idp.AdminDisableProviderForUser({
  "UserPoolId": "",
  "User": {}
}, context)

Input

• input object
  • User required ProviderUserIdentifierType
  • UserPoolId required StringType

Output

• output AdminDisableProviderForUserResponse

AdminDisableUser

amazonaws_cognito_idp.AdminDisableUser({
  "UserPoolId": "",
  "Username": ""
}, context)

Input

• input object
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminDisableUserResponse

AdminEnableUser

amazonaws_cognito_idp.AdminEnableUser({
  "UserPoolId": "",
  "Username": ""
}, context)

Input

• input object
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminEnableUserResponse

AdminForgetDevice

amazonaws_cognito_idp.AdminForgetDevice({
  "UserPoolId": "",
  "Username": "",
  "DeviceKey": ""
}, context)

Input

• input object
  • DeviceKey required DeviceKeyType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

Output schema unknown

AdminGetDevice

amazonaws_cognito_idp.AdminGetDevice({
  "DeviceKey": "",
  "UserPoolId": "",
  "Username": ""
}, context)

Input

• input object
  • DeviceKey required DeviceKeyType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminGetDeviceResponse

AdminGetUser

amazonaws_cognito_idp.AdminGetUser({
  "UserPoolId": "",
  "Username": ""
}, context)

Input

• input object
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminGetUserResponse

AdminInitiateAuth

amazonaws_cognito_idp.AdminInitiateAuth({
  "UserPoolId": "",
  "ClientId": "",
  "AuthFlow": ""
}, context)

Input

• input object
  • AnalyticsMetadata AnalyticsMetadataType
  • AuthFlow required AuthFlowType
  • AuthParameters AuthParametersType
  • ClientId required ClientIdType
  • ClientMetadata ClientMetadataType
  • ContextData ContextDataType
  • UserPoolId required UserPoolIdType

Output

• output AdminInitiateAuthResponse

AdminLinkProviderForUser

amazonaws_cognito_idp.AdminLinkProviderForUser({
  "UserPoolId": "",
  "DestinationUser": {},
  "SourceUser": {}
}, context)

Input

• input object
  • DestinationUser required ProviderUserIdentifierType
  • SourceUser required ProviderUserIdentifierType
  • UserPoolId required StringType

Output

• output AdminLinkProviderForUserResponse

AdminListDevices

amazonaws_cognito_idp.AdminListDevices({
  "UserPoolId": "",
  "Username": ""
}, context)

Input

• input object
  • Limit QueryLimitType
  • PaginationToken SearchPaginationTokenType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminListDevicesResponse

AdminListGroupsForUser

amazonaws_cognito_idp.AdminListGroupsForUser({
  "Username": "",
  "UserPoolId": ""
}, context)

Input

• input object
  • Limit QueryLimitType
  • NextToken PaginationKey
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminListGroupsForUserResponse

AdminListUserAuthEvents

amazonaws_cognito_idp.AdminListUserAuthEvents({
  "UserPoolId": "",
  "Username": ""
}, context)

Input

• input object
  • MaxResults QueryLimitType
  • NextToken PaginationKey
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminListUserAuthEventsResponse

AdminRemoveUserFromGroup

amazonaws_cognito_idp.AdminRemoveUserFromGroup({
  "UserPoolId": "",
  "Username": "",
  "GroupName": ""
}, context)

Input

• input object
  • GroupName required GroupNameType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

Output schema unknown

AdminResetUserPassword

amazonaws_cognito_idp.AdminResetUserPassword({
  "UserPoolId": "",
  "Username": ""
}, context)

Input

• input object
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminResetUserPasswordResponse

AdminRespondToAuthChallenge

amazonaws_cognito_idp.AdminRespondToAuthChallenge({
  "UserPoolId": "",
  "ClientId": "",
  "ChallengeName": ""
}, context)

Input

• input object
  • AnalyticsMetadata AnalyticsMetadataType
  • ChallengeName required ChallengeNameType
  • ChallengeResponses ChallengeResponsesType
  • ClientId required ClientIdType
  • ContextData ContextDataType
  • Session SessionType
  • UserPoolId required UserPoolIdType

Output

• output AdminRespondToAuthChallengeResponse

AdminSetUserMFAPreference

amazonaws_cognito_idp.AdminSetUserMFAPreference({
  "Username": "",
  "UserPoolId": ""
}, context)

Input

• input object
  • SMSMfaSettings SMSMfaSettingsType
  • SoftwareTokenMfaSettings SoftwareTokenMfaSettingsType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminSetUserMFAPreferenceResponse

AdminSetUserSettings

amazonaws_cognito_idp.AdminSetUserSettings({
  "UserPoolId": "",
  "Username": "",
  "MFAOptions": []
}, context)

Input

• input object
  • MFAOptions required MFAOptionListType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminSetUserSettingsResponse

AdminUpdateAuthEventFeedback

amazonaws_cognito_idp.AdminUpdateAuthEventFeedback({
  "UserPoolId": "",
  "Username": "",
  "EventId": "",
  "FeedbackValue": ""
}, context)

Input

• input object
  • EventId required EventIdType
  • FeedbackValue required FeedbackValueType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminUpdateAuthEventFeedbackResponse

AdminUpdateDeviceStatus

amazonaws_cognito_idp.AdminUpdateDeviceStatus({
  "UserPoolId": "",
  "Username": "",
  "DeviceKey": ""
}, context)

Input

• input object
  • DeviceKey required DeviceKeyType
  • DeviceRememberedStatus DeviceRememberedStatusType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminUpdateDeviceStatusResponse

AdminUpdateUserAttributes

amazonaws_cognito_idp.AdminUpdateUserAttributes({
  "UserPoolId": "",
  "Username": "",
  "UserAttributes": []
}, context)

Input

• input object
  • UserAttributes required AttributeListType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminUpdateUserAttributesResponse

AdminUserGlobalSignOut

amazonaws_cognito_idp.AdminUserGlobalSignOut({
  "UserPoolId": "",
  "Username": ""
}, context)

Input

• input object
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output AdminUserGlobalSignOutResponse

AssociateSoftwareToken

amazonaws_cognito_idp.AssociateSoftwareToken({}, context)

Input

• input object
  • AccessToken TokenModelType
  • Session SessionType

Output

• output AssociateSoftwareTokenResponse

ChangePassword

amazonaws_cognito_idp.ChangePassword({
  "PreviousPassword": "",
  "ProposedPassword": "",
  "AccessToken": ""
}, context)

Input

• input object
  • AccessToken required TokenModelType
  • PreviousPassword required PasswordType
  • ProposedPassword required PasswordType

Output

• output ChangePasswordResponse

ConfirmDevice

amazonaws_cognito_idp.ConfirmDevice({
  "AccessToken": "",
  "DeviceKey": ""
}, context)

Input

• input object
  • AccessToken required TokenModelType
  • DeviceKey required DeviceKeyType
  • DeviceName DeviceNameType
  • DeviceSecretVerifierConfig DeviceSecretVerifierConfigType

Output

• output ConfirmDeviceResponse

ConfirmForgotPassword

amazonaws_cognito_idp.ConfirmForgotPassword({
  "ClientId": "",
  "Username": "",
  "ConfirmationCode": "",
  "Password": ""
}, context)

Input

• input object
  • AnalyticsMetadata AnalyticsMetadataType
  • ClientId required ClientIdType
  • ConfirmationCode required ConfirmationCodeType
  • Password required PasswordType
  • SecretHash SecretHashType
  • UserContextData UserContextDataType
  • Username required UsernameType

Output

• output ConfirmForgotPasswordResponse

ConfirmSignUp

amazonaws_cognito_idp.ConfirmSignUp({
  "ClientId": "",
  "Username": "",
  "ConfirmationCode": ""
}, context)

Input

• input object
  • AnalyticsMetadata AnalyticsMetadataType
  • ClientId required ClientIdType
  • ConfirmationCode required ConfirmationCodeType
  • ForceAliasCreation ForceAliasCreation
  • SecretHash SecretHashType
  • UserContextData UserContextDataType
  • Username required UsernameType

Output

• output ConfirmSignUpResponse

CreateGroup

amazonaws_cognito_idp.CreateGroup({
  "GroupName": "",
  "UserPoolId": ""
}, context)

Input

• input object
  • Description DescriptionType
  • GroupName required GroupNameType
  • Precedence PrecedenceType
  • RoleArn ArnType
  • UserPoolId required UserPoolIdType

Output

• output CreateGroupResponse

CreateIdentityProvider

amazonaws_cognito_idp.CreateIdentityProvider({
  "UserPoolId": "",
  "ProviderName": "",
  "ProviderType": "",
  "ProviderDetails": []
}, context)

Input

• input object
  • AttributeMapping AttributeMappingType
  • IdpIdentifiers IdpIdentifiersListType
  • ProviderDetails required ProviderDetailsType
  • ProviderName required ProviderNameTypeV1
  • ProviderType required IdentityProviderTypeType
  • UserPoolId required UserPoolIdType

Output

• output CreateIdentityProviderResponse

CreateResourceServer

amazonaws_cognito_idp.CreateResourceServer({
  "UserPoolId": "",
  "Identifier": "",
  "Name": ""
}, context)

Input

• input object
  • Identifier required ResourceServerIdentifierType
  • Name required ResourceServerNameType
  • Scopes ResourceServerScopeListType
  • UserPoolId required UserPoolIdType

Output

• output CreateResourceServerResponse

CreateUserImportJob

amazonaws_cognito_idp.CreateUserImportJob({
  "JobName": "",
  "UserPoolId": "",
  "CloudWatchLogsRoleArn": ""
}, context)

Input

• input object
  • CloudWatchLogsRoleArn required ArnType
  • JobName required UserImportJobNameType
  • UserPoolId required UserPoolIdType

Output

• output CreateUserImportJobResponse

CreateUserPool

amazonaws_cognito_idp.CreateUserPool({
  "PoolName": ""
}, context)

Input

• input object
  • AdminCreateUserConfig AdminCreateUserConfigType
  • AliasAttributes AliasAttributesListType
  • AutoVerifiedAttributes VerifiedAttributesListType
  • DeviceConfiguration DeviceConfigurationType
  • EmailConfiguration EmailConfigurationType
  • EmailVerificationMessage EmailVerificationMessageType
  • EmailVerificationSubject EmailVerificationSubjectType
  • LambdaConfig LambdaConfigType
  • MfaConfiguration UserPoolMfaType
  • Policies UserPoolPolicyType
  • PoolName required UserPoolNameType
  • Schema SchemaAttributesListType
  • SmsAuthenticationMessage SmsVerificationMessageType
  • SmsConfiguration SmsConfigurationType
  • SmsVerificationMessage SmsVerificationMessageType
  • UserPoolAddOns UserPoolAddOnsType
  • UserPoolTags UserPoolTagsType
  • UsernameAttributes UsernameAttributesListType
  • VerificationMessageTemplate VerificationMessageTemplateType

Output

• output CreateUserPoolResponse

CreateUserPoolClient

amazonaws_cognito_idp.CreateUserPoolClient({
  "UserPoolId": "",
  "ClientName": ""
}, context)

Input

• input object
  • AllowedOAuthFlows OAuthFlowsType
  • AllowedOAuthFlowsUserPoolClient BooleanType
  • AllowedOAuthScopes ScopeListType
  • AnalyticsConfiguration AnalyticsConfigurationType
  • CallbackURLs CallbackURLsListType
  • ClientName required ClientNameType
  • DefaultRedirectURI RedirectUrlType
  • ExplicitAuthFlows ExplicitAuthFlowsListType
  • GenerateSecret GenerateSecret
  • LogoutURLs LogoutURLsListType
  • ReadAttributes ClientPermissionListType
  • RefreshTokenValidity RefreshTokenValidityType
  • SupportedIdentityProviders SupportedIdentityProvidersListType
  • UserPoolId required UserPoolIdType
  • WriteAttributes ClientPermissionListType

Output

• output CreateUserPoolClientResponse

CreateUserPoolDomain

amazonaws_cognito_idp.CreateUserPoolDomain({
  "Domain": "",
  "UserPoolId": ""
}, context)

Input

• input object
  • Domain required DomainType
  • UserPoolId required UserPoolIdType

Output

• output CreateUserPoolDomainResponse

DeleteGroup

amazonaws_cognito_idp.DeleteGroup({
  "GroupName": "",
  "UserPoolId": ""
}, context)

Input

• input object
  • GroupName required GroupNameType
  • UserPoolId required UserPoolIdType

Output

Output schema unknown

DeleteIdentityProvider

amazonaws_cognito_idp.DeleteIdentityProvider({
  "UserPoolId": "",
  "ProviderName": ""
}, context)

Input

• input object
  • ProviderName required ProviderNameType
  • UserPoolId required UserPoolIdType

Output

Output schema unknown

DeleteResourceServer

amazonaws_cognito_idp.DeleteResourceServer({
  "UserPoolId": "",
  "Identifier": ""
}, context)

Input

• input object
  • Identifier required ResourceServerIdentifierType
  • UserPoolId required UserPoolIdType

Output

Output schema unknown

DeleteUser

amazonaws_cognito_idp.DeleteUser({
  "AccessToken": ""
}, context)

Input

• input object
  • AccessToken required TokenModelType

Output

Output schema unknown

DeleteUserAttributes

amazonaws_cognito_idp.DeleteUserAttributes({
  "UserAttributeNames": [],
  "AccessToken": ""
}, context)

Input

• input object
  • AccessToken required TokenModelType
  • UserAttributeNames required AttributeNameListType

Output

• output DeleteUserAttributesResponse

DeleteUserPool

amazonaws_cognito_idp.DeleteUserPool({
  "UserPoolId": ""
}, context)

Input

• input object
  • UserPoolId required UserPoolIdType

Output

Output schema unknown

DeleteUserPoolClient

amazonaws_cognito_idp.DeleteUserPoolClient({
  "UserPoolId": "",
  "ClientId": ""
}, context)

Input

• input object
  • ClientId required ClientIdType
  • UserPoolId required UserPoolIdType

Output

Output schema unknown

DeleteUserPoolDomain

amazonaws_cognito_idp.DeleteUserPoolDomain({
  "Domain": "",
  "UserPoolId": ""
}, context)

Input

• input object
  • Domain required DomainType
  • UserPoolId required UserPoolIdType

Output

• output DeleteUserPoolDomainResponse

DescribeIdentityProvider

amazonaws_cognito_idp.DescribeIdentityProvider({
  "UserPoolId": "",
  "ProviderName": ""
}, context)

Input

• input object
  • ProviderName required ProviderNameType
  • UserPoolId required UserPoolIdType

Output

• output DescribeIdentityProviderResponse

DescribeResourceServer

amazonaws_cognito_idp.DescribeResourceServer({
  "UserPoolId": "",
  "Identifier": ""
}, context)

Input

• input object
  • Identifier required ResourceServerIdentifierType
  • UserPoolId required UserPoolIdType

Output

• output DescribeResourceServerResponse

DescribeRiskConfiguration

amazonaws_cognito_idp.DescribeRiskConfiguration({
  "UserPoolId": ""
}, context)

Input

• input object
  • ClientId ClientIdType
  • UserPoolId required UserPoolIdType

Output

• output DescribeRiskConfigurationResponse

DescribeUserImportJob

amazonaws_cognito_idp.DescribeUserImportJob({
  "UserPoolId": "",
  "JobId": ""
}, context)

Input

• input object
  • JobId required UserImportJobIdType
  • UserPoolId required UserPoolIdType

Output

• output DescribeUserImportJobResponse

DescribeUserPool

amazonaws_cognito_idp.DescribeUserPool({
  "UserPoolId": ""
}, context)

Input

• input object
  • UserPoolId required UserPoolIdType

Output

• output DescribeUserPoolResponse

DescribeUserPoolClient

amazonaws_cognito_idp.DescribeUserPoolClient({
  "UserPoolId": "",
  "ClientId": ""
}, context)

Input

• input object
  • ClientId required ClientIdType
  • UserPoolId required UserPoolIdType

Output

• output DescribeUserPoolClientResponse

DescribeUserPoolDomain

amazonaws_cognito_idp.DescribeUserPoolDomain({
  "Domain": ""
}, context)

Input

• input object
  • Domain required DomainType

Output

• output DescribeUserPoolDomainResponse

ForgetDevice

amazonaws_cognito_idp.ForgetDevice({
  "DeviceKey": ""
}, context)

Input

• input object
  • AccessToken TokenModelType
  • DeviceKey required DeviceKeyType

Output

Output schema unknown

ForgotPassword

amazonaws_cognito_idp.ForgotPassword({
  "ClientId": "",
  "Username": ""
}, context)

Input

• input object
  • AnalyticsMetadata AnalyticsMetadataType
  • ClientId required ClientIdType
  • SecretHash SecretHashType
  • UserContextData UserContextDataType
  • Username required UsernameType

Output

• output ForgotPasswordResponse

GetCSVHeader

amazonaws_cognito_idp.GetCSVHeader({
  "UserPoolId": ""
}, context)

Input

• input object
  • UserPoolId required UserPoolIdType

Output

• output GetCSVHeaderResponse

GetDevice

amazonaws_cognito_idp.GetDevice({
  "DeviceKey": ""
}, context)

Input

• input object
  • AccessToken TokenModelType
  • DeviceKey required DeviceKeyType

Output

• output GetDeviceResponse

GetGroup

amazonaws_cognito_idp.GetGroup({
  "GroupName": "",
  "UserPoolId": ""
}, context)

Input

• input object
  • GroupName required GroupNameType
  • UserPoolId required UserPoolIdType

Output

• output GetGroupResponse

GetIdentityProviderByIdentifier

amazonaws_cognito_idp.GetIdentityProviderByIdentifier({
  "UserPoolId": "",
  "IdpIdentifier": ""
}, context)

Input

• input object
  • IdpIdentifier required IdpIdentifierType
  • UserPoolId required UserPoolIdType

Output

• output GetIdentityProviderByIdentifierResponse

GetSigningCertificate

amazonaws_cognito_idp.GetSigningCertificate({
  "UserPoolId": ""
}, context)

Input

• input object
  • UserPoolId required UserPoolIdType

Output

• output GetSigningCertificateResponse

GetUICustomization

amazonaws_cognito_idp.GetUICustomization({
  "UserPoolId": ""
}, context)

Input

• input object
  • ClientId ClientIdType
  • UserPoolId required UserPoolIdType

Output

• output GetUICustomizationResponse

GetUser

amazonaws_cognito_idp.GetUser({
  "AccessToken": ""
}, context)

Input

• input object
  • AccessToken required TokenModelType

Output

• output GetUserResponse

GetUserAttributeVerificationCode

amazonaws_cognito_idp.GetUserAttributeVerificationCode({
  "AccessToken": "",
  "AttributeName": ""
}, context)

Input

• input object
  • AccessToken required TokenModelType
  • AttributeName required AttributeNameType

Output

• output GetUserAttributeVerificationCodeResponse

GetUserPoolMfaConfig

amazonaws_cognito_idp.GetUserPoolMfaConfig({
  "UserPoolId": ""
}, context)

Input

• input object
  • UserPoolId required UserPoolIdType

Output

• output GetUserPoolMfaConfigResponse

GlobalSignOut

amazonaws_cognito_idp.GlobalSignOut({
  "AccessToken": ""
}, context)

Input

• input object
  • AccessToken required TokenModelType

Output

• output GlobalSignOutResponse

InitiateAuth

amazonaws_cognito_idp.InitiateAuth({
  "AuthFlow": "",
  "ClientId": ""
}, context)

Input

• input object
  • AnalyticsMetadata AnalyticsMetadataType
  • AuthFlow required AuthFlowType
  • AuthParameters AuthParametersType
  • ClientId required ClientIdType
  • ClientMetadata ClientMetadataType
  • UserContextData UserContextDataType

Output

• output InitiateAuthResponse

ListDevices

amazonaws_cognito_idp.ListDevices({
  "AccessToken": ""
}, context)

Input

• input object
  • AccessToken required TokenModelType
  • Limit QueryLimitType
  • PaginationToken SearchPaginationTokenType

Output

• output ListDevicesResponse

ListGroups

amazonaws_cognito_idp.ListGroups({
  "UserPoolId": ""
}, context)

Input

• input object
  • Limit QueryLimitType
  • NextToken PaginationKey
  • UserPoolId required UserPoolIdType

Output

• output ListGroupsResponse

ListIdentityProviders

amazonaws_cognito_idp.ListIdentityProviders({
  "UserPoolId": ""
}, context)

Input

• input object
  • MaxResults ListProvidersLimitType
  • NextToken PaginationKeyType
  • UserPoolId required UserPoolIdType

Output

• output ListIdentityProvidersResponse

ListResourceServers

amazonaws_cognito_idp.ListResourceServers({
  "UserPoolId": ""
}, context)

Input

• input object
  • MaxResults ListResourceServersLimitType
  • NextToken PaginationKeyType
  • UserPoolId required UserPoolIdType

Output

• output ListResourceServersResponse

ListUserImportJobs

amazonaws_cognito_idp.ListUserImportJobs({
  "UserPoolId": "",
  "MaxResults": 0
}, context)

Input

• input object
  • MaxResults required PoolQueryLimitType
  • PaginationToken PaginationKeyType
  • UserPoolId required UserPoolIdType

Output

• output ListUserImportJobsResponse

ListUserPoolClients

amazonaws_cognito_idp.ListUserPoolClients({
  "UserPoolId": ""
}, context)

Input

• input object
  • MaxResults QueryLimit
  • NextToken PaginationKey
  • UserPoolId required UserPoolIdType

Output

• output ListUserPoolClientsResponse

ListUserPools

amazonaws_cognito_idp.ListUserPools({
  "MaxResults": 0
}, context)

Input

• input object
  • MaxResults required PoolQueryLimitType
  • NextToken PaginationKeyType

Output

• output ListUserPoolsResponse

ListUsers

amazonaws_cognito_idp.ListUsers({
  "UserPoolId": ""
}, context)

Input

• input object
  • AttributesToGet SearchedAttributeNamesListType
  • Filter UserFilterType
  • Limit QueryLimitType
  • PaginationToken SearchPaginationTokenType
  • UserPoolId required UserPoolIdType

Output

• output ListUsersResponse

ListUsersInGroup

amazonaws_cognito_idp.ListUsersInGroup({
  "UserPoolId": "",
  "GroupName": ""
}, context)

Input

• input object
  • GroupName required GroupNameType
  • Limit QueryLimitType
  • NextToken PaginationKey
  • UserPoolId required UserPoolIdType

Output

• output ListUsersInGroupResponse

ResendConfirmationCode

amazonaws_cognito_idp.ResendConfirmationCode({
  "ClientId": "",
  "Username": ""
}, context)

Input

• input object
  • AnalyticsMetadata AnalyticsMetadataType
  • ClientId required ClientIdType
  • SecretHash SecretHashType
  • UserContextData UserContextDataType
  • Username required UsernameType

Output

• output ResendConfirmationCodeResponse

RespondToAuthChallenge

amazonaws_cognito_idp.RespondToAuthChallenge({
  "ClientId": "",
  "ChallengeName": ""
}, context)

Input

• input object
  • AnalyticsMetadata AnalyticsMetadataType
  • ChallengeName required ChallengeNameType
  • ChallengeResponses ChallengeResponsesType
  • ClientId required ClientIdType
  • Session SessionType
  • UserContextData UserContextDataType

Output

• output RespondToAuthChallengeResponse

SetRiskConfiguration

amazonaws_cognito_idp.SetRiskConfiguration({
  "UserPoolId": ""
}, context)

Input

• input object
  • AccountTakeoverRiskConfiguration AccountTakeoverRiskConfigurationType
  • ClientId ClientIdType
  • CompromisedCredentialsRiskConfiguration CompromisedCredentialsRiskConfigurationType
  • RiskExceptionConfiguration RiskExceptionConfigurationType
  • UserPoolId required UserPoolIdType

Output

• output SetRiskConfigurationResponse

SetUICustomization

amazonaws_cognito_idp.SetUICustomization({
  "UserPoolId": ""
}, context)

Input

• input object
  • CSS CSSType
  • ClientId ClientIdType
  • ImageFile ImageFileType
  • UserPoolId required UserPoolIdType

Output

• output SetUICustomizationResponse

SetUserMFAPreference

amazonaws_cognito_idp.SetUserMFAPreference({
  "AccessToken": ""
}, context)

Input

• input object
  • AccessToken required TokenModelType
  • SMSMfaSettings SMSMfaSettingsType
  • SoftwareTokenMfaSettings SoftwareTokenMfaSettingsType

Output

• output SetUserMFAPreferenceResponse

SetUserPoolMfaConfig

amazonaws_cognito_idp.SetUserPoolMfaConfig({
  "UserPoolId": ""
}, context)

Input

• input object
  • MfaConfiguration UserPoolMfaType
  • SmsMfaConfiguration SmsMfaConfigType
  • SoftwareTokenMfaConfiguration SoftwareTokenMfaConfigType
  • UserPoolId required UserPoolIdType

Output

• output SetUserPoolMfaConfigResponse

SetUserSettings

amazonaws_cognito_idp.SetUserSettings({
  "AccessToken": "",
  "MFAOptions": []
}, context)

Input

• input object
  • AccessToken required TokenModelType
  • MFAOptions required MFAOptionListType

Output

• output SetUserSettingsResponse

SignUp

amazonaws_cognito_idp.SignUp({
  "ClientId": "",
  "Username": "",
  "Password": ""
}, context)

Input

• input object
  • AnalyticsMetadata AnalyticsMetadataType
  • ClientId required ClientIdType
  • Password required PasswordType
  • SecretHash SecretHashType
  • UserAttributes AttributeListType
  • UserContextData UserContextDataType
  • Username required UsernameType
  • ValidationData AttributeListType

Output

• output SignUpResponse

StartUserImportJob

amazonaws_cognito_idp.StartUserImportJob({
  "UserPoolId": "",
  "JobId": ""
}, context)

Input

• input object
  • JobId required UserImportJobIdType
  • UserPoolId required UserPoolIdType

Output

• output StartUserImportJobResponse

StopUserImportJob

amazonaws_cognito_idp.StopUserImportJob({
  "UserPoolId": "",
  "JobId": ""
}, context)

Input

• input object
  • JobId required UserImportJobIdType
  • UserPoolId required UserPoolIdType

Output

• output StopUserImportJobResponse

UpdateAuthEventFeedback

amazonaws_cognito_idp.UpdateAuthEventFeedback({
  "UserPoolId": "",
  "Username": "",
  "EventId": "",
  "FeedbackToken": "",
  "FeedbackValue": ""
}, context)

Input

• input object
  • EventId required EventIdType
  • FeedbackToken required TokenModelType
  • FeedbackValue required FeedbackValueType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

Output

• output UpdateAuthEventFeedbackResponse

UpdateDeviceStatus

amazonaws_cognito_idp.UpdateDeviceStatus({
  "AccessToken": "",
  "DeviceKey": ""
}, context)

Input

• input object
  • AccessToken required TokenModelType
  • DeviceKey required DeviceKeyType
  • DeviceRememberedStatus DeviceRememberedStatusType

Output

• output UpdateDeviceStatusResponse

UpdateGroup

amazonaws_cognito_idp.UpdateGroup({
  "GroupName": "",
  "UserPoolId": ""
}, context)

Input

• input object
  • Description DescriptionType
  • GroupName required GroupNameType
  • Precedence PrecedenceType
  • RoleArn ArnType
  • UserPoolId required UserPoolIdType

Output

• output UpdateGroupResponse

UpdateIdentityProvider

amazonaws_cognito_idp.UpdateIdentityProvider({
  "UserPoolId": "",
  "ProviderName": ""
}, context)

Input

• input object
  • AttributeMapping AttributeMappingType
  • IdpIdentifiers IdpIdentifiersListType
  • ProviderDetails ProviderDetailsType
  • ProviderName required ProviderNameType
  • UserPoolId required UserPoolIdType

Output

• output UpdateIdentityProviderResponse

UpdateResourceServer

amazonaws_cognito_idp.UpdateResourceServer({
  "UserPoolId": "",
  "Identifier": "",
  "Name": ""
}, context)

Input

• input object
  • Identifier required ResourceServerIdentifierType
  • Name required ResourceServerNameType
  • Scopes ResourceServerScopeListType
  • UserPoolId required UserPoolIdType

Output

• output UpdateResourceServerResponse

UpdateUserAttributes

amazonaws_cognito_idp.UpdateUserAttributes({
  "UserAttributes": [],
  "AccessToken": ""
}, context)

Input

• input object
  • AccessToken required TokenModelType
  • UserAttributes required AttributeListType

Output

• output UpdateUserAttributesResponse

UpdateUserPool

amazonaws_cognito_idp.UpdateUserPool({
  "UserPoolId": ""
}, context)

Input

• input object
  • AdminCreateUserConfig AdminCreateUserConfigType
  • AutoVerifiedAttributes VerifiedAttributesListType
  • DeviceConfiguration DeviceConfigurationType
  • EmailConfiguration EmailConfigurationType
  • EmailVerificationMessage EmailVerificationMessageType
  • EmailVerificationSubject EmailVerificationSubjectType
  • LambdaConfig LambdaConfigType
  • MfaConfiguration UserPoolMfaType
  • Policies UserPoolPolicyType
  • SmsAuthenticationMessage SmsVerificationMessageType
  • SmsConfiguration SmsConfigurationType
  • SmsVerificationMessage SmsVerificationMessageType
  • UserPoolAddOns UserPoolAddOnsType
  • UserPoolId required UserPoolIdType
  • UserPoolTags UserPoolTagsType
  • VerificationMessageTemplate VerificationMessageTemplateType

Output

• output UpdateUserPoolResponse

UpdateUserPoolClient

amazonaws_cognito_idp.UpdateUserPoolClient({
  "UserPoolId": "",
  "ClientId": ""
}, context)

Input

• input object
  • AllowedOAuthFlows OAuthFlowsType
  • AllowedOAuthFlowsUserPoolClient BooleanType
  • AllowedOAuthScopes ScopeListType
  • AnalyticsConfiguration AnalyticsConfigurationType
  • CallbackURLs CallbackURLsListType
  • ClientId required ClientIdType
  • ClientName ClientNameType
  • DefaultRedirectURI RedirectUrlType
  • ExplicitAuthFlows ExplicitAuthFlowsListType
  • LogoutURLs LogoutURLsListType
  • ReadAttributes ClientPermissionListType
  • RefreshTokenValidity RefreshTokenValidityType
  • SupportedIdentityProviders SupportedIdentityProvidersListType
  • UserPoolId required UserPoolIdType
  • WriteAttributes ClientPermissionListType

Output

• output UpdateUserPoolClientResponse

VerifySoftwareToken

amazonaws_cognito_idp.VerifySoftwareToken({
  "UserCode": ""
}, context)

Input

• input object
  • AccessToken TokenModelType
  • FriendlyDeviceName StringType
  • Session SessionType
  • UserCode required SoftwareTokenMFAUserCodeType

Output

• output VerifySoftwareTokenResponse

VerifyUserAttribute

amazonaws_cognito_idp.VerifyUserAttribute({
  "AccessToken": "",
  "AttributeName": "",
  "Code": ""
}, context)

Input

• input object
  • AccessToken required TokenModelType
  • AttributeName required AttributeNameType
  • Code required ConfirmationCodeType

Output

• output VerifyUserAttributeResponse

Definitions

AWSAccountIdType

• AWSAccountIdType string

AccountTakeoverActionNotifyType

• AccountTakeoverActionNotifyType boolean

AccountTakeoverActionType

• AccountTakeoverActionType object: Account takeover action type.
  • EventAction required AccountTakeoverEventActionType
  • Notify required AccountTakeoverActionNotifyType

AccountTakeoverActionsType

• AccountTakeoverActionsType object: Account takeover actions type.
  • HighAction AccountTakeoverActionType
  • LowAction AccountTakeoverActionType
  • MediumAction AccountTakeoverActionType

AccountTakeoverEventActionType

• AccountTakeoverEventActionType string (values: BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION)

AccountTakeoverRiskConfigurationType

• AccountTakeoverRiskConfigurationType object: Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
  • Actions required AccountTakeoverActionsType
  • NotifyConfiguration NotifyConfigurationType

AddCustomAttributesRequest

• AddCustomAttributesRequest object: Represents the request to add custom attributes.
  • CustomAttributes required CustomAttributesListType
  • UserPoolId required UserPoolIdType

AddCustomAttributesResponse

• AddCustomAttributesResponse object: Represents the response from the server for the request to add custom attributes.

AdminAddUserToGroupRequest

• AdminAddUserToGroupRequest object
  • GroupName required GroupNameType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminConfirmSignUpRequest

• AdminConfirmSignUpRequest object: Represents the request to confirm user registration.
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminConfirmSignUpResponse

• AdminConfirmSignUpResponse object: Represents the response from the server for the request to confirm registration.

AdminCreateUserConfigType

• AdminCreateUserConfigType object: The configuration for creating a new user profile.
  • AllowAdminCreateUserOnly BooleanType
  • InviteMessageTemplate MessageTemplateType
  • UnusedAccountValidityDays AdminCreateUserUnusedAccountValidityDaysType

AdminCreateUserRequest

• AdminCreateUserRequest object: Represents the request to create a user in the specified user pool.
  • DesiredDeliveryMediums DeliveryMediumListType
  • ForceAliasCreation ForceAliasCreation
  • MessageAction MessageActionType
  • TemporaryPassword PasswordType
  • UserAttributes AttributeListType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType
  • ValidationData AttributeListType

AdminCreateUserResponse

• AdminCreateUserResponse object: Represents the response from the server to the request to create the user.
  • User UserType

AdminCreateUserUnusedAccountValidityDaysType

• AdminCreateUserUnusedAccountValidityDaysType integer

AdminDeleteUserAttributesRequest

• AdminDeleteUserAttributesRequest object: Represents the request to delete user attributes as an administrator.
  • UserAttributeNames required AttributeNameListType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminDeleteUserAttributesResponse

• AdminDeleteUserAttributesResponse object: Represents the response received from the server for a request to delete user attributes.

AdminDeleteUserRequest

• AdminDeleteUserRequest object: Represents the request to delete a user as an administrator.
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminDisableProviderForUserRequest

• AdminDisableProviderForUserRequest object
  • User required ProviderUserIdentifierType
  • UserPoolId required StringType

AdminDisableProviderForUserResponse

• AdminDisableProviderForUserResponse object

AdminDisableUserRequest

• AdminDisableUserRequest object: Represents the request to disable any user as an administrator.
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminDisableUserResponse

• AdminDisableUserResponse object: Represents the response received from the server to disable the user as an administrator.

AdminEnableUserRequest

• AdminEnableUserRequest object: Represents the request that enables the user as an administrator.
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminEnableUserResponse

• AdminEnableUserResponse object: Represents the response from the server for the request to enable a user as an administrator.

AdminForgetDeviceRequest

• AdminForgetDeviceRequest object: Sends the forgot device request, as an administrator.
  • DeviceKey required DeviceKeyType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminGetDeviceRequest

• AdminGetDeviceRequest object: Represents the request to get the device, as an administrator.
  • DeviceKey required DeviceKeyType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminGetDeviceResponse

• AdminGetDeviceResponse object: Gets the device response, as an administrator.
  • Device required DeviceType

AdminGetUserRequest

• AdminGetUserRequest object: Represents the request to get the specified user as an administrator.
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminGetUserResponse

• AdminGetUserResponse object: Represents the response from the server from the request to get the specified user as an administrator.
  • Enabled BooleanType
  • MFAOptions MFAOptionListType
  • PreferredMfaSetting StringType
  • UserAttributes AttributeListType
  • UserCreateDate DateType
  • UserLastModifiedDate DateType
  • UserMFASettingList UserMFASettingListType
  • UserStatus UserStatusType
  • Username required UsernameType

AdminInitiateAuthRequest

• AdminInitiateAuthRequest object: Initiates the authorization request, as an administrator.
  • AnalyticsMetadata AnalyticsMetadataType
  • AuthFlow required AuthFlowType
  • AuthParameters AuthParametersType
  • ClientId required ClientIdType
  • ClientMetadata ClientMetadataType
  • ContextData ContextDataType
  • UserPoolId required UserPoolIdType

AdminInitiateAuthResponse

• AdminInitiateAuthResponse object: Initiates the authentication response, as an administrator.
  • AuthenticationResult AuthenticationResultType
  • ChallengeName ChallengeNameType
  • ChallengeParameters ChallengeParametersType
  • Session SessionType

AdminLinkProviderForUserRequest

• AdminLinkProviderForUserRequest object
  • DestinationUser required ProviderUserIdentifierType
  • SourceUser required ProviderUserIdentifierType
  • UserPoolId required StringType

AdminLinkProviderForUserResponse

• AdminLinkProviderForUserResponse object

AdminListDevicesRequest

• AdminListDevicesRequest object: Represents the request to list devices, as an administrator.
  • Limit QueryLimitType
  • PaginationToken SearchPaginationTokenType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminListDevicesResponse

• AdminListDevicesResponse object: Lists the device's response, as an administrator.
  • Devices DeviceListType
  • PaginationToken SearchPaginationTokenType

AdminListGroupsForUserRequest

• AdminListGroupsForUserRequest object
  • Limit QueryLimitType
  • NextToken PaginationKey
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminListGroupsForUserResponse

• AdminListGroupsForUserResponse object
  • Groups GroupListType
  • NextToken PaginationKey

AdminListUserAuthEventsRequest

• AdminListUserAuthEventsRequest object
  • MaxResults QueryLimitType
  • NextToken PaginationKey
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminListUserAuthEventsResponse

• AdminListUserAuthEventsResponse object
  • AuthEvents AuthEventsType
  • NextToken PaginationKey

AdminRemoveUserFromGroupRequest

• AdminRemoveUserFromGroupRequest object
  • GroupName required GroupNameType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminResetUserPasswordRequest

• AdminResetUserPasswordRequest object: Represents the request to reset a user's password as an administrator.
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminResetUserPasswordResponse

• AdminResetUserPasswordResponse object: Represents the response from the server to reset a user password as an administrator.

AdminRespondToAuthChallengeRequest

• AdminRespondToAuthChallengeRequest object: The request to respond to the authentication challenge, as an administrator.
  • AnalyticsMetadata AnalyticsMetadataType
  • ChallengeName required ChallengeNameType
  • ChallengeResponses ChallengeResponsesType
  • ClientId required ClientIdType
  • ContextData ContextDataType
  • Session SessionType
  • UserPoolId required UserPoolIdType

AdminRespondToAuthChallengeResponse

• AdminRespondToAuthChallengeResponse object: Responds to the authentication challenge, as an administrator.
  • AuthenticationResult AuthenticationResultType
  • ChallengeName ChallengeNameType
  • ChallengeParameters ChallengeParametersType
  • Session SessionType

AdminSetUserMFAPreferenceRequest

• AdminSetUserMFAPreferenceRequest object
  • SMSMfaSettings SMSMfaSettingsType
  • SoftwareTokenMfaSettings SoftwareTokenMfaSettingsType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminSetUserMFAPreferenceResponse

• AdminSetUserMFAPreferenceResponse object

AdminSetUserSettingsRequest

• AdminSetUserSettingsRequest object: Represents the request to set user settings as an administrator.
  • MFAOptions required MFAOptionListType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminSetUserSettingsResponse

• AdminSetUserSettingsResponse object: Represents the response from the server to set user settings as an administrator.

AdminUpdateAuthEventFeedbackRequest

• AdminUpdateAuthEventFeedbackRequest object
  • EventId required EventIdType
  • FeedbackValue required FeedbackValueType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminUpdateAuthEventFeedbackResponse

• AdminUpdateAuthEventFeedbackResponse object

AdminUpdateDeviceStatusRequest

• AdminUpdateDeviceStatusRequest object: The request to update the device status, as an administrator.
  • DeviceKey required DeviceKeyType
  • DeviceRememberedStatus DeviceRememberedStatusType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminUpdateDeviceStatusResponse

• AdminUpdateDeviceStatusResponse object: The status response from the request to update the device, as an administrator.

AdminUpdateUserAttributesRequest

• AdminUpdateUserAttributesRequest object: Represents the request to update the user's attributes as an administrator.
  • UserAttributes required AttributeListType
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminUpdateUserAttributesResponse

• AdminUpdateUserAttributesResponse object: Represents the response from the server for the request to update user attributes as an administrator.

AdminUserGlobalSignOutRequest

• AdminUserGlobalSignOutRequest object: The request to sign out of all devices, as an administrator.
  • UserPoolId required UserPoolIdType
  • Username required UsernameType

AdminUserGlobalSignOutResponse

• AdminUserGlobalSignOutResponse object: The global sign-out response, as an administrator.

AdvancedSecurityModeType

• AdvancedSecurityModeType string (values: OFF, AUDIT, ENFORCED)

AliasAttributeType

• AliasAttributeType string (values: phone_number, email, preferred_username)

AliasAttributesListType

• AliasAttributesListType array
  • items AliasAttributeType

AliasExistsException

• AliasExistsException object: This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.
  • message MessageType

AnalyticsConfigurationType

• AnalyticsConfigurationType object: The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.
  • ApplicationId required HexStringType
  • ExternalId required StringType
  • RoleArn required ArnType
  • UserDataShared BooleanType

AnalyticsMetadataType

• AnalyticsMetadataType object: An Amazon Pinpoint analytics endpoint. An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.
  • AnalyticsEndpointId StringType

ArnType

• ArnType string

AssociateSoftwareTokenRequest

• AssociateSoftwareTokenRequest object
  • AccessToken TokenModelType
  • Session SessionType

AssociateSoftwareTokenResponse

• AssociateSoftwareTokenResponse object
  • SecretCode SecretCodeType
  • Session SessionType

AttributeDataType

• AttributeDataType string (values: String, Number, DateTime, Boolean)

AttributeListType

• AttributeListType array
  • items AttributeType

AttributeMappingKeyType

• AttributeMappingKeyType string

AttributeMappingType

• AttributeMappingType array
  • items object
    • key AttributeMappingKeyType
    • value StringType

AttributeNameListType

• AttributeNameListType array
  • items AttributeNameType

AttributeNameType

• AttributeNameType string

AttributeType

• AttributeType object: Specifies whether the attribute is standard or custom.
  • Name required AttributeNameType
  • Value AttributeValueType

AttributeValueType

• AttributeValueType string

AuthEventType

• AuthEventType object: The authentication event type.
  • ChallengeResponses ChallengeResponseListType
  • CreationDate DateType
  • EventContextData EventContextDataType
  • EventFeedback EventFeedbackType
  • EventId StringType
  • EventResponse EventResponseType
  • EventRisk EventRiskType
  • EventType EventType

AuthEventsType

• AuthEventsType array
  • items AuthEventType

AuthFlowType

• AuthFlowType string (values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH)

AuthParametersType

• AuthParametersType array
  • items object
    • key StringType
    • value StringType

AuthenticationResultType

• AuthenticationResultType object: The authentication result.
  • AccessToken TokenModelType
  • ExpiresIn IntegerType
  • IdToken TokenModelType
  • NewDeviceMetadata NewDeviceMetadataType
  • RefreshToken TokenModelType
  • TokenType StringType

BlockedIPRangeListType

• BlockedIPRangeListType array
  • items StringType

BooleanType

• BooleanType boolean

CSSType

• CSSType string

CSSVersionType

• CSSVersionType string

CallbackURLsListType

• CallbackURLsListType array
  • items RedirectUrlType

ChallengeName

• ChallengeName string (values: Password, Mfa)

ChallengeNameType

• ChallengeNameType string (values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED)

ChallengeParametersType

• ChallengeParametersType array
  • items object
    • key StringType
    • value StringType

ChallengeResponse

• ChallengeResponse string (values: Success, Failure)

ChallengeResponseListType

• ChallengeResponseListType array
  • items ChallengeResponseType

ChallengeResponseType

• ChallengeResponseType object: The challenge response type.
  • ChallengeName ChallengeName
  • ChallengeResponse ChallengeResponse

ChallengeResponsesType

• ChallengeResponsesType array
  • items object
    • key StringType
    • value StringType

ChangePasswordRequest

• ChangePasswordRequest object: Represents the request to change a user password.
  • AccessToken required TokenModelType
  • PreviousPassword required PasswordType
  • ProposedPassword required PasswordType

Cha