Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

post/restapis/{restapi_id}/authorizers/{authorizer_id}

Path parameters

restapi_idstring required

The string identifier of the associated RestApi.

authorizer_idstring required

Specifies a test invoke authorizer request's Authorizer ID.

Request body

headersobject

A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

multiValueHeadersobject

The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.

pathWithQueryStringstring

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

bodystring

The simulated request body of an incoming invocation request.

stageVariablesobject

A key-value map of stage variables to simulate an invocation on a deployed Stage.

additionalContextobject

A key-value map of additional context variables.

Response

Success

clientStatusinteger

The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

logstring

The API Gateway execution log for the test authorizer request.

latencyinteger

The execution latency of the test authorizer request.

principalIdstring

The principal identity returned by the Authorizer

policystring

The JSON policy document returned by the Authorizer

authorizationobject

The authorization response.

claimsobject

The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.