Authorizerの照会
    • PDF

    Authorizerの照会

    • PDF

    記事の要約

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

    Authorizerの情報を照会します。

    リクエスト

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

    メソッドURI
    GET/authorizers/{authorizer-id}

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    authorizer-idStringRequired照会対象の Authorizer ID

    リクエスト例

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

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

    レスポンス

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

    レスポンス構文

    構文は次の通りです。

    {
        "authorizerId": "authorizerId",
        "tenantId": "tenantId",
        "authorizerName": "authorizerName",
        "authorizerDescription": "authorizerDescription",
        "authorizerType": "authorizerType",
        "authorizerConfig": {
            "region": "region",
            "functionId": "functionId",
            "payload": [
                {
                    "in": "in",
                    "name": "name"
                }
            ]
        },
        "modifier": "modifier",
        "domainCode": "domainCode",
        "modTime": "2024-05-02T08:23:41Z"
    }
    

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

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

    レスポンス例

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

    {
        "authorizerId": "*********",
        "tenantId": "***4402f55ae4436913a6e2c65bab***",
        "authorizerName": "authorizer-***",
        "authorizerDescription": "authorizerDescription",
        "authorizerType": "CLOUD_FUNCTIONS",
        "authorizerConfig": {
            "region": "KR",
            "functionId": "*****/mypackage/myaction",
            "payload": [
                {
                    "in": "HEADER",
                    "name": "payload-***"
                }
            ]
        },
        "modifier": "d12c9fd0-****-****-****-246e96591a38",
        "domainCode": "PUB",
        "modTime": "2024-05-02T08:23:41Z"
    }
    

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

    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.