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
    • 입력 값이 null일 수 없음
    authorizerTypeStringRequiredAuthorizer의 지원 서비스(유형)
    • CLOUD_FUNCTIONS
    authorizerDescriptionStringOptional생성할 Authorizer에 대한 설명
    • 0~300자

    요청 예시

    요청 예시는 다음과 같습니다.

    curl -X PUT 'https://apigateway.apigw.gov-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.