Authorizerの変更

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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

Authorizer設定を変更します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト構文

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

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`authorizerName`	String	Required	Authorizer名英数字、記号の「-」、「_」を使用して1~20文字以内で入力
`authorizerConfig`	Object	Required	Authorizerの構成情報
`authorizerConfig.functionId`	String	Required	Authorizerでサポートするサービス(タイプ)の Function名 <例> Cloud Functionsサービスの Action名
`authorizerConfig.payload[]`	String	Required	認証処理のために Authorizerに渡すためのリクエストタイプ(ヘッダまたはクエリ文字列)を選択し、変数名を入力
`authorizerConfig.payload[].in`	String	Required	Payloadタイプ `HEADER` \| `QUERY STRING` `HEADER`: ヘッダ `QUERY STRING`: クエリ文字列
`authorizerConfig.payload[].name`	String	Required	Payload変数名
`authorizerConfig.region`	String	Required	Authorizerのサポートサービス(タイプ)の Cloud Functionのリージョンコード `KR` \| `JPN` \| `SGN` 入力値は nullであってはいけない
`authorizerType`	String	Required	Authorizerのサポートサービス(タイプ) `CLOUD_FUNCTIONS`
`authorizerDescription`	String	Optional	作成する 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のレスポンスステータスコードをご参照ください。

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

What's Next

Authorizerのテスト

リクエスト
レスポンス