Authorizerリストの照会

Classic/VPC環境で利用できます。

Authorizerのリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/authorizers

リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`offset`	Long	Optional	照会対象のデータリストからスタートする位置 0~9,223,372,036,854,775,807
`limit`	Long	Optional	一度に照会するデータ数 1~9,223,372,036,854,775,807
`name`	String	Optional	Authorizer名でフィルタリング 0~20

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンス構文

構文は次の通りです。

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

レスポンスステータスコード

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

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