Backend appId Auth backendEnvironmentName Details - AWS Amplify Admin UI

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 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

{ "resourceName": "string" }

Response bodies

{ "resourceConfig": { "userPoolConfigs": { "userPoolName": "string", "forgotPassword": { "smsSettings": { }, "deliveryMethod": enum, "emailSettings": { } }, "passwordPolicy": { "minimumLength": number, "additionalConstraints": [ enum ] }, "requiredSignUpAttributes": [ enum ], "mfa": { "MFAMode": enum, "settings": { } }, "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" }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string", "limitType": "string" }
{ "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

Describes the forgot password policy for authenticating into the Amplify app.

Property Type Required Description
smsSettings

object

False

The configuration for the SMS message sent when an app user forgets their password.

deliveryMethod

string

Values: EMAIL | SMS

True

Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.

emailSettings

object

False

The configuration for the email 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 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 (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.

Property Type Required Description
MFAMode

string

Values: 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
redirectSignOutURIs

Array of type string

True

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

domainPrefix

string

False

The domain prefix for your Amplify app.

redirectSignInURIs

Array of type string

True

The redirected URI for signing in to your Amplify app.

oAuthScopes

Array of type string

Values: PHONE | EMAIL | OPENID | PROFILE | AWS_COGNITO_SIGNIN_USER_ADMIN

True

List of OAuth-related flows that allow your app users to authenticate from your Amplify app.

socialProviderSettings

object

False

The settings for using social identity providers for access to your Amplify app.

oAuthGrantType

string

Values: CODE | IMPLICIT

True

The OAuth grant type that you use to allow app users to authenticate from your Amplify app.

CreateBackendAuthPasswordPolicyConfig

The password policy configuration for the backend of your Amplify project.

Property Type Required Description
minimumLength

number

True

The minimum length of the password used to access the backend of your Amplify project.

additionalConstraints

Array of type string

Values: REQUIRE_DIGIT | REQUIRE_LOWERCASE | REQUIRE_SYMBOL | REQUIRE_UPPERCASE

False

Additional constraints for 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
userPoolConfigs

CreateBackendAuthUserPoolConfig

True

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

authResources

string

Values: USER_POOL_ONLY | IDENTITY_POOL_AND_USER_POOL

True

Defines whether you want to configure only authentication or both authentication and authorization settings.

service

string

Values: COGNITO

True

Defines the service name to use when configuring an authentication resource in your Amplify project.

identityPoolConfigs

CreateBackendAuthIdentityPoolConfig

False

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of the auth resource in your 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
userPoolName

string

True

The Amazon Cognito user pool name.

forgotPassword

CreateBackendAuthForgotPasswordConfig

False

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

passwordPolicy

CreateBackendAuthPasswordPolicyConfig

False

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

requiredSignUpAttributes

Array of type string

Values: 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 Amazon Cognito user pool.

mfa

CreateBackendAuthMFAConfig

False

Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.

oAuth

CreateBackendAuthOAuthConfig

False

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

signInMethod

string

Values: EMAIL | EMAIL_AND_PHONE_NUMBER | PHONE_NUMBER | USERNAME

True

Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.

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
resourceConfig

CreateBackendAuthResourceConfig

False

The resource configuration for authorization requests to the backend of your Amplify project.

appId

string

True

The app ID.

resourceName

string

False

The name of this resource.

error

string

False

If the request failed, this is the returned error.

backendEnvironmentName

string

True

The name of the backend environment.

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 is exceeded.

Property Type Required Description
message

string

False

An error message to inform that the request failed.

limitType

string

False

The type of limit that was exceeded.

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 failed.

resourceType

string

False

The type of resource that wasn't found.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetBackendAuth