Authorizer
    • PDF

    Authorizer

    • PDF

    Article Summary

    Authorizer生成

    URL

    POST https://apigateway.apigw.ntruss.com/api/v1/authorizers
    

    リクエストパラメータ

    • なし

    リクエストボディ

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

    応答コード

    • 201

    応答ボディ

    {
      "cacheTtlSec" : 0,
      "authorizerId" : "authorizerId",
      "domainCode" : "domainCode",
      "modTime" : "2000-01-23T04:56:07.000+00:00",
      "modifier" : "modifier",
      "authorizerName" : "authorizerName",
      "tenantId" : "tenantId",
      "authorizerConfig" : {
        "functionId" : "functionId",
        "payload" : [ {
          "in" : "HEADER",
          "name" : "name"
        } ],
        "region" : "region"
      },
      "authorizerType" : "authorizerType",
      "authorizerDescription" : "authorizerDescription"
    }
    

    Authorizer削除

    URL

    DELETE https://apigateway.apigw.ntruss.com/api/v1/authorizers/{authorizer-id}
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    authorizerIdpathYStringAuthorizer Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    • なし

    応答コード

    • 204

    応答ボディ

    • なし

    Authorizer照会

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/authorizers/{authorizer-id}
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    authorizerIdpathYStringAuthorizer Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    • なし

    応答コード

    • 200

    応答ボディ

    {
      "cacheTtlSec" : 0,
      "authorizerId" : "authorizerId",
      "domainCode" : "domainCode",
      "modTime" : "2000-01-23T04:56:07.000+00:00",
      "modifier" : "modifier",
      "authorizerName" : "authorizerName",
      "tenantId" : "tenantId",
      "authorizerConfig" : {
        "functionId" : "functionId",
        "payload" : [ {
          "in" : "HEADER",
          "name" : "name"
        } ],
        "region" : "region"
      },
      "authorizerType" : "authorizerType",
      "authorizerDescription" : "authorizerDescription"
    }
    

    Authorizerリスト検索

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/authorizers
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    offsetquery stringNLongOffset
    最小:0
    最大:9,223,372,036,854,775,807
    limitquery stringNLongLimit
    最小:1
    最大:9,223,372,036,854,775,807
    namequery stringNStringName
    長さ(最大/最小):0 / 20

    リクエストボディ

    • なし

    応答コード

    • 200

    応答ボディ

    {
      "initialCount" : 0,
      "total" : 6,
      "authorizers" : [ {
        "authorizerId" : "authorizerId",
        "authorizerName" : "authorizerName",
        "disabled" : true,
        "permission" : "permission",
        "authorizerDescription" : "authorizerDescription",
        "actionName" : "actionName"
      } ]
    }
    

    Authorizer修正

    URL

    PUT https://apigateway.apigw.ntruss.com/api/v1/authorizers/{authorizer-id}
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    authorizerIdpathYStringAuthorizer Id
    長さ(最大/最小):0 / 10

    リクエストボディ

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

    応答コード

    • 204

    応答ボディ

    • なし

    Authorizerテスト

    URL

    POST https://apigateway.apigw.ntruss.com/api/v1/authorizers/{authorizer-id}/test
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    authorizerIdpathYStringAuthorizer Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    {
      "params" : "{}"
    }
    

    応答コード

    • 200

    応答ボディ

    {
      "response" : {
        "latency" : "latency",
        "body" : "{}",
        "status" : 0
      }
    }
    

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

    What's Next
    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.