Test authorizer

Available in Classic and VPC

Test a create authorizer.

Request

The following describes the request format for the endpoint. The request format is as follows:

Request headers

For headers common to API Gateway, see API Gateway common request headers.

Request path parameters

The following describes the parameters.

Request syntax

The request syntax is as follows.

{
  "params" : "{}"
}

Request body

The following describes the request body.

Request example

The following is a sample request.

curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/authorizers/{authorizer-id}/test' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--data '{
  "payload-***" : "{}"
}'

Response

The following describes the response format.

Response syntax

The syntax is as follows.

{
    "response": {
        "latency": "latency",
        "status": status,
        "header": {[]},
        "body": "{}"
    }
}

Response status codes

For response status codes common to API Gateway, see API Gateway response status codes.

Response example

The following is a sample response.

{
    "response": {
        "latency": "22 ms",
        "status": 202,
        "header": {
            "Server": [
                "nginx"
            ],
            "Date": [
                "Fri, 03 May 2024 05:15:41 GMT"
            ],
            "Content-Type": [
                "application/json"
            ],
            "Content-Length": [
                "51"
            ],
            "Connection": [
                "keep-alive"
            ],
            "X-Request-ID": [
                "*****87ed34d5d19b9871ccd017ffe9c",
                "*****87ed34d5d19b9871ccd017ffe9c"
            ],
            "Access-Control-Allow-Origin": [
                "*"
            ],
            "Access-Control-Allow-Headers": [
                "Authorization, Origin, X-Requested-With, Content-Type, Accept, User-Agent"
            ],
            "Access-Control-Allow-Methods": [
                "GET, DELETE, POST, PUT, HEAD"
            ],
            "x-openwhisk-activation-id": [
                "*****8db2b45b4959c08db2b85b41b"
            ]
        },
        "body": "{\"activationId\":\"*****c08db2b45b4959c08db2b85b41b\"}"
    }
}