URI HTTP methods Schemas Properties See also

Backend appId Auth backendEnvironmentName

The authentication and authorization settings from your Amplify project.

URI

/prod/backend/appId/auth/backendEnvironmentName

HTTP methods

POST

Operation ID: UpdateBackendAuth

Updates an existing backend authentication resource.

Path parameters
Name	Type	Required	Description
`appId`	String	True	The app ID.
`backendEnvironmentName`	String	True	The name of the backend environment.

Responses
Status code	Response model	Description
`200`	`BackendAuthRespObj`	200 response
`400`	`BadRequestException`	400 response
`404`	`NotFoundException`	404 response
`429`	`LimitExceededException`	429 response
`504`	`InternalServiceException`	504 response

OPTIONS

Enables CORS by returning the correct headers.

Path parameters
Name	Type	Required	Description
`appId`	String	True	The app ID.
`backendEnvironmentName`	String	True	The name of the backend environment.

Responses
Status code	Response model	Description
`200`	None	200 response

Schemas

Request bodies


{
  "resourceConfig": {
    "userPoolConfigs": {
      "forgotPassword": {
        "smsSettings": {
          "smsMessage": "string"
        },
        "deliveryMethod": enum,
        "emailSettings": {
          "emailMessage": "string",
          "emailSubject": "string"
        }
      },
      "passwordPolicy": {
        "minimumLength": number,
        "additionalConstraints": [
          enum
        ]
      },
      "mfa": {
        "MFAMode": enum,
        "settings": {
        }
      },
      "oAuth": {
        "redirectSignOutURIs": [
          "string"
        ],
        "domainPrefix": "string",
        "redirectSignInURIs": [
          "string"
        ],
        "oAuthScopes": [
          enum
        ],
        "socialProviderSettings": {
        },
        "oAuthGrantType": enum
      },
      "verificationMessage": {
        "smsSettings": {
          "smsMessage": "string"
        },
        "deliveryMethod": enum,
        "emailSettings": {
          "emailMessage": "string",
          "emailSubject": "string"
        }
      }
    },
    "authResources": enum,
    "service": enum,
    "identityPoolConfigs": {
      "unauthenticatedLogin": boolean
    }
  },
  "resourceName": "string"
}

Response bodies


{
  "jobId": "string",
  "appId": "string",
  "error": "string",
  "operation": "string",
  "backendEnvironmentName": "string",
  "status": "string"
}


{
  "message": "string"
}


{
  "message": "string",
  "resourceType": "string"
}


{
  "message": "string",
  "limitType": "string"
}


{
  "message": "string"
}

Properties

BackendAuthRespObj

The response object for this operation.

Property	Type	Required	Description
`appId`	string	True	The app ID.
`backendEnvironmentName`	string	True	The name of the backend environment.
`error`	string	False	If the request fails, this error is returned.
`jobId`	string	False	The ID for the job.
`operation`	string	False	The name of the operation.
`status`	string	False	The current status of the request.

BadRequestException

An error returned if a request is not formed properly.

Property	Type	Required	Description
`message`	string	False	An error message to inform that the request failed.

DeliveryMethod

The type of verification message to send.

EMAIL
SMS

EmailSettings

The settings for the email message.

Property	Type	Required	Description
`emailMessage`	string	False	The contents of the email message.
`emailSubject`	string	False	The contents of the subject line of the email message.

InternalServiceException

An error returned if there's a temporary issue with the service.

Property	Type	Required	Description
`message`	string	False	An error message to inform that the request failed.

LimitExceededException

An error that is returned when a limit of a specific type has been exceeded.

Property	Type	Required	Description
`limitType`	string	False	The type of limit that was exceeded.
`message`	string	False	An error message to inform that the request has failed.

NotFoundException

An error returned when a specific resource type is not found.

Property	Type	Required	Description
`message`	string	False	An error message to inform that the request has failed.
`resourceType`	string	False	The type of resource that is not found.

SmsSettings

The settings for the SMS message.

Property	Type	Required	Description
`smsMessage`	string	False	The contents of the SMS message.

UpdateBackendAuthForgotPasswordConfig

(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.

Property	Type	Required	Description
`deliveryMethod`	DeliveryMethod	False	(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
`emailSettings`	EmailSettings	False	(DEPRECATED) The configuration for the email sent when an app user forgets their password.
`smsSettings`	SmsSettings	False	(DEPRECATED) The configuration for the SMS message sent when an Amplify app user forgets their password.

UpdateBackendAuthIdentityPoolConfig

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

Property	Type	Required	Description
`unauthenticatedLogin`	boolean	False	A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.

UpdateBackendAuthMFAConfig

Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.

Property Type Required Description

Property	Type	Required	Description
`MFAMode`	string Values: `ON \| OFF \| OPTIONAL`	False	The MFA mode for the backend of your Amplify project.
`settings`	object	False	The settings of your MFA configuration for the backend of your Amplify project.

MFAMode

string

Values: ON | OFF | OPTIONAL

False

The MFA mode for the backend of your Amplify project.

settings

object

False

The settings of your MFA configuration for the backend of your Amplify project.

UpdateBackendAuthOAuthConfig

The OAuth configurations for authenticating users into your Amplify app.

Property	Type	Required	Description
`domainPrefix`	string	False	The Amazon Cognito domain prefix used to create a hosted UI for authentication.
`oAuthGrantType`	string Values: `CODE \| IMPLICIT`	False	The OAuth grant type to allow app users to authenticate from your Amplify app.
`oAuthScopes`	Array of type string Values: `PHONE \| EMAIL \| OPENID \| PROFILE \| AWS_COGNITO_SIGNIN_USER_ADMIN`	False	The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
`redirectSignInURIs`	Array of type string	False	Redirect URLs that OAuth uses when a user signs in to an Amplify app.
`redirectSignOutURIs`	Array of type string	False	Redirect URLs that OAuth uses when a user signs out of an Amplify app.
`socialProviderSettings`	object	False	Describes third-party social federation configurations for allowing your users to sign in with OAuth.

UpdateBackendAuthPasswordPolicyConfig

Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.

Property Type Required Description

Property	Type	Required	Description
`additionalConstraints`	Array of type string Values: `REQUIRE_DIGIT \| REQUIRE_LOWERCASE \| REQUIRE_SYMBOL \| REQUIRE_UPPERCASE`	False	Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.
`minimumLength`	number	False	Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.

additionalConstraints

Array of type string

Values: REQUIRE_DIGIT | REQUIRE_LOWERCASE | REQUIRE_SYMBOL | REQUIRE_UPPERCASE

False

Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.

minimumLength

number

False

Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.

UpdateBackendAuthReqObj

The request object for this operation.

Property	Type	Required	Description
`resourceConfig`	UpdateBackendAuthResourceConfig	True	The resource configuration for this request object.
`resourceName`	string	True	The name of this resource.

UpdateBackendAuthResourceConfig

Defines the resource configuration when updating an authentication resource in your Amplify project.

Property	Type	Required	Description
`authResources`	string Values: `USER_POOL_ONLY \| IDENTITY_POOL_AND_USER_POOL`	True	Defines the service name to use when configuring an authentication resource in your Amplify project.
`identityPoolConfigs`	UpdateBackendAuthIdentityPoolConfig	False	Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
`service`	string Values: `COGNITO`	True	Defines the service name to use when configuring an authentication resource in your Amplify project.
`userPoolConfigs`	UpdateBackendAuthUserPoolConfig	True	Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.

UpdateBackendAuthUserPoolConfig

Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.

Property	Type	Required	Description
`forgotPassword`	UpdateBackendAuthForgotPasswordConfig	False	(DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`mfa`	UpdateBackendAuthMFAConfig	False	Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
`oAuth`	UpdateBackendAuthOAuthConfig	False	Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
`passwordPolicy`	UpdateBackendAuthPasswordPolicyConfig	False	Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`verificationMessage`	UpdateBackendAuthVerificationMessageConfig	False	Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

UpdateBackendAuthVerificationMessageConfig

Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.

Property	Type	Required	Description
`deliveryMethod`	DeliveryMethod	True	The type of verification message to send.
`emailSettings`	EmailSettings	False	The settings for the email message.
`smsSettings`	SmsSettings	False	The settings for the SMS message.