Backend appId Challenge - AWS Amplify Admin UI

Backend appId Challenge

The one-time challenge code used to authenticate a user into your Amplify Admin UI.

URI

/prod/backend/appId/challenge

HTTP methods

POST

Operation ID: CreateToken

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

Path parameters
Name Type Required Description
appId String True

The app ID.

Responses
Status code Response model Description
200 CreateTokenRespObj

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.

Responses
Status code Response model Description
200 None

200 response

Schemas

Response bodies

{ "appId": "string", "sessionId": "string", "ttl": "string", "challengeCode": "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.

CreateTokenRespObj

The response object for this operation.

Property Type Required Description
appId

string

True

The app ID.

sessionId

string

True

A unique ID provided when creating a new challenge token.

ttl

string

True

The expiry time for the one-time generated token code.

challengeCode

string

True

One-time challenge code for authenticating into the Amplify Admin UI.

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:

CreateToken