# Backend appId Auth backendEnvironmentName Details The authentication and authorization settings from your Amplify project. ## URI `/prod/backend/appId/auth/backendEnvironmentName/details` ## HTTP methods ### POST **Operation ID:** `GetBackendAuth` Gets a backend auth details. **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 | GetBackendAuthRespObj | 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 #### POST schema POST ``` { "resourceName": "string" } ``` ### Response bodies #### GetBackendAuthRespObj schema GetBackendAuthRespObj ``` { "resourceConfig": { "userPoolConfigs": { "userPoolName": "string", "forgotPassword": { "smsSettings": { "smsMessage": "string" }, "deliveryMethod": enum, "emailSettings": { "emailMessage": "string", "emailSubject": "string" } }, "passwordPolicy": { "minimumLength": number, "additionalConstraints": [ enum ] }, "requiredSignUpAttributes": [ enum ], "mfa": { "MFAMode": enum, "settings": { } }, "verificationMessage": { "smsSettings": { "smsMessage": "string" }, "deliveryMethod": enum, "emailSettings": { "emailMessage": "string", "emailSubject": "string" } }, "oAuth": { "redirectSignOutURIs": [ "string" ], "domainPrefix": "string", "redirectSignInURIs": [ "string" ], "oAuthScopes": [ enum ], "socialProviderSettings": { }, "oAuthGrantType": enum }, "signInMethod": enum }, "authResources": enum, "service": enum, "identityPoolConfigs": { "identityPoolName": "string", "unauthenticatedLogin": boolean } }, "appId": "string", "resourceName": "string", "error": "string", "backendEnvironmentName": "string" } ``` #### BadRequestException schema BadRequestException ``` { "message": "string" } ``` #### NotFoundException schema NotFoundException ``` { "message": "string", "resourceType": "string" } ``` #### LimitExceededException schema LimitExceededException ``` { "message": "string", "limitType": "string" } ``` #### InternalServiceException schema InternalServiceException ``` { "message": "string" } ``` ## Properties ### 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. | ### CreateBackendAuthForgotPasswordConfig **(DEPRECATED)** Describes the forgot password policy for authenticating into the Amplify app. | Property | Type | Required | Description | | --- |--- |--- |--- | | deliveryMethod | [DeliveryMethod](#backend-appid-auth-backendenvironmentname-details-model-deliverymethod) | True | **(DEPRECATED)** Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password. | | emailSettings | [EmailSettings](#backend-appid-auth-backendenvironmentname-details-model-emailsettings) | False | **(DEPRECATED)** The configuration for the email sent when an app user forgets their password. | | smsSettings | [SmsSettings](#backend-appid-auth-backendenvironmentname-details-model-smssettings) | False | **(DEPRECATED)** The configuration for the SMS message sent when an app user forgets their password. | ### CreateBackendAuthIdentityPoolConfig Describes authorization configurations for the auth resources, configured as a part of your Amplify project. | Property | Type | Required | Description | | --- |--- |--- |--- | | identityPoolName | string | True | Name of the Amazon Cognito identity pool used for authorization. | | unauthenticatedLogin | boolean | True | Set to true or false based on whether you want to enable guest authorization to your Amplify app. | ### CreateBackendAuthMFAConfig Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project. | Property | Type | Required | Description | | --- |--- |--- |--- | | MFAMode | stringValues: `ON \| OFF \| OPTIONAL` | True | Describes whether MFA should be [`ON`, `OFF`, or `OPTIONAL`] for authentication in your Amplify project. | | settings | object | False | Describes the configuration settings and methods for your Amplify app users to use MFA. | ### CreateBackendAuthOAuthConfig Creates the OAuth configuration for your Amplify project. | Property | Type | Required | Description | | --- |--- |--- |--- | | domainPrefix | string | False | The domain prefix for your Amplify app. | | oAuthGrantType | stringValues: `CODE \| IMPLICIT` | True | The OAuth grant type that you use to allow app users to authenticate from your Amplify app. | | oAuthScopes | Array of type stringValues: `PHONE \| EMAIL \| OPENID \| PROFILE \| AWS_COGNITO_SIGNIN_USER_ADMIN` | True | List of OAuth-related flows used to allow your app users to authenticate from your Amplify app. | | redirectSignInURIs | Array of type string | True | The redirected URI for signing in to your Amplify app. | | redirectSignOutURIs | Array of type string | True | Redirect URLs that OAuth uses when a user signs out of an Amplify app. | | socialProviderSettings | object | False | The settings for using social providers to access your Amplify app. | ### CreateBackendAuthPasswordPolicyConfig The password policy configuration for the backend to your Amplify project. | Property | Type | Required | Description | | --- |--- |--- |--- | | additionalConstraints | Array of type stringValues: `REQUIRE_DIGIT \| REQUIRE_LOWERCASE \| REQUIRE_SYMBOL \| REQUIRE_UPPERCASE` | False | Additional constraints for the password used to access the backend of your Amplify project. | | minimumLength | number | True | The minimum length of the password used to access the backend of your Amplify project. | ### CreateBackendAuthResourceConfig Defines the resource configuration when creating an auth resource in your Amplify project. | Property | Type | Required | Description | | --- |--- |--- |--- | | authResources | stringValues: `USER_POOL_ONLY \| IDENTITY_POOL_AND_USER_POOL` | True | Defines whether you want to configure only authentication or both authentication and authorization settings. | | identityPoolConfigs | [CreateBackendAuthIdentityPoolConfig](#backend-appid-auth-backendenvironmentname-details-model-createbackendauthidentitypoolconfig) | False | Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project. | | service | stringValues: `COGNITO` | True | Defines the service name to use when configuring an authentication resource in your Amplify project. | | userPoolConfigs | [CreateBackendAuthUserPoolConfig](#backend-appid-auth-backendenvironmentname-details-model-createbackendauthuserpoolconfig) | True | Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project. | ### CreateBackendAuthUserPoolConfig Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project. | Property | Type | Required | Description | | --- |--- |--- |--- | | forgotPassword | [CreateBackendAuthForgotPasswordConfig](#backend-appid-auth-backendenvironmentname-details-model-createbackendauthforgotpasswordconfig) | False | **(DEPRECATED)** Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project. | | mfa | [CreateBackendAuthMFAConfig](#backend-appid-auth-backendenvironmentname-details-model-createbackendauthmfaconfig) | False | Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project. | | oAuth | [CreateBackendAuthOAuthConfig](#backend-appid-auth-backendenvironmentname-details-model-createbackendauthoauthconfig) | False | Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project. | | passwordPolicy | [CreateBackendAuthPasswordPolicyConfig](#backend-appid-auth-backendenvironmentname-details-model-createbackendauthpasswordpolicyconfig) | False | Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project. | | requiredSignUpAttributes | Array of type stringValues: `ADDRESS \| BIRTHDATE \| EMAIL \| FAMILY_NAME \| GENDER \| GIVEN_NAME \| LOCALE \| MIDDLE_NAME \| NAME \| NICKNAME \| PHONE_NUMBER \| PICTURE \| PREFERRED_USERNAME \| PROFILE \| UPDATED_AT \| WEBSITE \| ZONE_INFO` | True | The required attributes to sign up new users in the user pool. | | signInMethod | stringValues: `EMAIL \| EMAIL_AND_PHONE_NUMBER \| PHONE_NUMBER \| USERNAME` | True | Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project. | | userPoolName | string | True | The Amazon Cognito user pool name. | | verificationMessage | [CreateBackendAuthVerificationMessageConfig](#backend-appid-auth-backendenvironmentname-details-model-createbackendauthverificationmessageconfig) | False | Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project. | ### CreateBackendAuthVerificationMessageConfig Creates an email or SMS verification message for the auth resource configured for your Amplify project. | Property | Type | Required | Description | | --- |--- |--- |--- | | deliveryMethod | [DeliveryMethod](#backend-appid-auth-backendenvironmentname-details-model-deliverymethod) | True | The type of verification message to send. | | emailSettings | [EmailSettings](#backend-appid-auth-backendenvironmentname-details-model-emailsettings) | False | The settings for the email message. | | smsSettings | [SmsSettings](#backend-appid-auth-backendenvironmentname-details-model-smssettings) | False | The settings for the SMS message. | ### 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. | ### GetBackendAuthReqObj The request object for this operation. | Property | Type | Required | Description | | --- |--- |--- |--- | | resourceName | string | True | The name of this resource. | ### GetBackendAuthRespObj 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. | | resourceConfig | [CreateBackendAuthResourceConfig](#backend-appid-auth-backendenvironmentname-details-model-createbackendauthresourceconfig) | False | The resource configuration for authorization requests to the backend of your Amplify project. | | resourceName | string | False | The name of this resource. | ### 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. | ## See also For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### GetBackendAuth + [AWS Command Line Interface V2](/goto/cli2/amplifybackend-2020-08-11/GetBackendAuth) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/amplifybackend-2020-08-11/GetBackendAuth) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/amplifybackend-2020-08-11/GetBackendAuth) + [AWS SDK for Go v2](/goto/SdkForGoV2/amplifybackend-2020-08-11/GetBackendAuth) + [AWS SDK for Java V2](/goto/SdkForJavaV2/amplifybackend-2020-08-11/GetBackendAuth) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/amplifybackend-2020-08-11/GetBackendAuth) + [AWS SDK for Kotlin](/goto/SdkForKotlin/amplifybackend-2020-08-11/GetBackendAuth) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/amplifybackend-2020-08-11/GetBackendAuth) + [AWS SDK for Python](/goto/boto3/amplifybackend-2020-08-11/GetBackendAuth) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/amplifybackend-2020-08-11/GetBackendAuth)