View authorizer list

Available in Classic and VPC

View the list of authorizers.

Request

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

Method	URI
GET	/authorizers

Request headers

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

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`offset`	Long	Optional	Starting point in the list of data to view 0 - 9,223,372,036,854,775,807
`limit`	Long	Optional	Number of data to view at once 1 - 9,223,372,036,854,775,807
`name`	String	Optional	Filter by authorizer name 0 - 20

Request example

The following is a sample request.

curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/authorizers' \
--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}'

Response

The following describes the response format.

Response syntax

The syntax is as follows.

{
    "authorizers": [
        {
            "authorizerId": "authorizerId",
            "authorizerName": "authorizerName",
            "authorizerDescription": "authorizerDescription"
        }
    ],
    "total": 0,
    "initialCount": 0
}

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.

{
    "authorizers": [
        {
            "authorizerId": "***gct7vcr",
            "authorizerName": "authorizer-****",
            "authorizerDescription": "authorizer-**** Description"
        }
    ],
    "total": 1,
    "initialCount": 1
}