Test Invoke Authorizer

apigateway_test_invoke_authorizer

R Documentation

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

Description¶

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

Usage¶

apigateway_test_invoke_authorizer(restApiId, authorizerId, headers,
  multiValueHeaders, pathWithQueryString, body, stageVariables,
  additionalContext)

Arguments¶

restApiId: [required] The string identifier of the associated RestApi.
authorizerId: [required] Specifies a test invoke authorizer request's Authorizer ID.
headers: 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.
multiValueHeaders: 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.
pathWithQueryString: The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
body: The simulated request body of an incoming invocation request.
stageVariables: A key-value map of stage variables to simulate an invocation on a deployed Stage.
additionalContext: A key-value map of additional context variables.

Value¶

A list with the following syntax:

list(
  clientStatus = 123,
  log = "string",
  latency = 123,
  principalId = "string",
  policy = "string",
  authorization = list(
    list(
      "string"
    )
  ),
  claims = list(
    "string"
  )
)

Request syntax¶

svc$test_invoke_authorizer(
  restApiId = "string",
  authorizerId = "string",
  headers = list(
    "string"
  ),
  multiValueHeaders = list(
    list(
      "string"
    )
  ),
  pathWithQueryString = "string",
  body = "string",
  stageVariables = list(
    "string"
  ),
  additionalContext = list(
    "string"
  )
)