Backend appId Challenge - 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
NameTypeRequiredDescription
appIdStringTrue

The app ID.

Responses
Status codeResponse modelDescription
200CreateTokenRespObj

200 response

400BadRequestException

400 response

404NotFoundException

404 response

429LimitExceededException

429 response

504InternalServiceException

504 response

OPTIONS

Enables CORS by returning the correct headers.

Path parameters
NameTypeRequiredDescription
appIdStringTrue

The app ID.

Responses
Status codeResponse modelDescription
200None

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.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request failed.

CreateTokenRespObj

The response object for this operation.

PropertyTypeRequiredDescription
appId

string

True

The app ID.

challengeCode

string

True

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

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.

InternalServiceException

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

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

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

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request has failed.

resourceType

string

False

The type of resource that is not found.

See also

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

CreateToken