Authorizer 생성
    • PDF

    Authorizer 생성

    • PDF

    기사 요약

    Classic/VPC 환경에서 이용 가능합니다.

    API 사용 시의 인증 방법으로 사용할 수 있는 Authorizer를 생성합니다.

    요청

    요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

    메서드URI
    POST/authorizers

    요청 헤더

    API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.

    요청 구문

    요청 구문은 다음과 같습니다.

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

    요청 바디

    요청 바디에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    authorizerNameStringRequired생성할 Authorizer 이름
    • 1~20자로 영문자, 숫자, 특수 문자 '-', '_'을 허용
    authorizerConfigObjectRequired생성할 Authorizer의 구성 정보
    authorizerConfig.functionIdStringRequired생성할 Authorizer에서 지원할 서비스(유형)의 Function 이름
    • <예시> Cloud Functions 서비스의 Action 이름
    authorizerConfig.payload[]StringRequired인증 처리를 위해 Authorizer로 전달하기 위한 요청 유형(헤더 또는 쿼리 스트링) 선택 및 변수 이름 입력
    authorizerConfig.payload[].inStringRequired지정할 Payload 유형
    • HEADER | QUERY STRING
      • HEADER: 헤더
      • QUERY STRING: 쿼리 스트링
    authorizerConfig.payload[].nameStringRequiredPayload 변수 이름
    authorizerConfig.regionStringRequired생성할 Authorizer의 지원 서비스(유형)가 있는 지역 선택
    authorizerTypeStringRequiredAuthorizer의 지원 서비스(유형) 선택
    authorizerDescriptionStringOptional생성할 Authorizer에 대한 설명 입력
    • 0~300자

    요청 예시

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

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

    응답

    응답 형식을 설명합니다.

    응답 구문

    구문은 다음과 같습니다.

    {
        "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-03T01:26:57Z"
    }
    

    응답 상태 코드

    API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.

    응답 예시

    응답 예시는 다음과 같습니다.

    {
        "authorizerId": "***yddjd2m",
        "tenantId": "***4402f55ae4436913a6e2c65bab47c",
        "authorizerName": "authorizer-***",
        "authorizerDescription": "authorizer-*** Description",
        "authorizerType": "CLOUD_FUNCTIONS",
        "authorizerConfig": {
            "region": "KR",
            "functionId": "***/***",
            "payload": [
                {
                    "in": "HEADER",
                    "name": "payload-***"
                }
            ]
        },
        "modifier": "d12c9fd0-****-****-****-246e96591a38",
        "domainCode": "GOV",
        "modTime": "2024-05-03T01:26:57Z"
    }
    

    이 문서가 도움이 되었습니까?

    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.