MENU
      Authorizerリストの照会

        Authorizerリストの照会


        記事の要約

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

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

        リクエスト

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

        メソッドURI
        GET/authorizers

        リクエストヘッダ

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

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

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

        フィールドタイプ必須の有無説明
        offsetLongOptional照会対象のデータリストからスタートする位置
        • 0~9,223,372,036,854,775,807
        limitLongOptional一度に照会するデータ数
        • 1~9,223,372,036,854,775,807
        nameStringOptionalAuthorizer名でフィルタリング
        • 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}'
        Curl

        レスポンス

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

        レスポンス構文

        構文は次の通りです。

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

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

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

        レスポンス例

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

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

        この記事は役に立ちましたか?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.