Authorizerの変更
    • PDF

    Authorizerの変更

    • PDF

    記事の要約

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

    Authorizer設定を変更します。

    リクエスト

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

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

    リクエストヘッダ

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

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

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

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

    リクエスト構文

    リクエスト構文は次の通りです。

    {
      "authorizerName" : "authorizerName",
      "authorizerConfig" : {
        "functionId" : "functionId",
        "payload" : [ {
          "in" : "HEADER",
          "name" : "name"
        } ],
        "region" : "region"
      },
      "authorizerType" : "CLOUD_FUNCTIONS",
      "authorizerDescription" : "authorizerDescription"
    }
    

    リクエストボディ

    リクエストボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    authorizerNameStringRequiredAuthorizer名
    • 英数字、記号の「-」、「_」を使用して1~20文字以内で入力
    authorizerConfigObjectRequiredAuthorizerの構成情報
    authorizerConfig.functionIdStringRequiredAuthorizerでサポートするサービス(タイプ)の Function名
    • <例> Cloud Functionsサービスの Action名
    authorizerConfig.payload[]StringRequired認証処理のために Authorizerに渡すためのリクエストタイプ(ヘッダまたはクエリ文字列)を選択し、変数名を入力
    authorizerConfig.payload[].inStringRequiredPayloadタイプ
    • HEADER | QUERY STRING
      • HEADER: ヘッダ
      • QUERY STRING: クエリ文字列
    authorizerConfig.payload[].nameStringRequiredPayload変数名
    authorizerConfig.regionStringRequiredAuthorizerのサポートサービス(タイプ)の Cloud Functionのリージョンコード
    • KR | JPN | SGN
    • 入力値は nullであってはいけない
    authorizerTypeStringRequiredAuthorizerのサポートサービス(タイプ)
    • CLOUD_FUNCTIONS
    authorizerDescriptionStringOptional作成する Authorizerの説明
    • 0~300文字

    リクエスト例

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

    curl -X PUT '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}'
    --data '{
      "authorizerName" : "authorizer-***",
      "authorizerConfig" : {
        "functionId" : "functionId",
        "payload" : [ {
          "in" : "HEADER",
          "name" : "payload-***"
        } ],
        "region" : "region"
      },
      "authorizerType" : "CLOUD_FUNCTIONS",
      "authorizerDescription" : "authorizer-*** Description"
    }'
    

    レスポンス

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

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

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


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

    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.