Authorizer 생성

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

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

요청

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

메서드	URI
POST	/api/v1/authorizers

요청 헤더

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

요청 구문

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

{
  "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`	Array	Required	인증 처리를 위해 Authorizer로 전달하기 위한 요청 유형(헤더 또는 쿼리 스트링) 선택 및 변수 이름 입력 정보: payload
`authorizerConfig.region`	String	Required	생성할 Authorizer의 지원 서비스(유형)가 있는 지역 선택
`authorizerType`	String	Required	Authorizer의 지원 서비스(유형) 선택
`authorizerDescription`	String	Optional	생성할 Authorizer에 대한 설명 입력 0~300자

`payload`

payload에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`in`	String	Required	지정할 Payload 유형 `HEADER` \| `QUERY STRING` `HEADER`: 헤더 `QUERY STRING`: 쿼리 스트링
`name`	String	Required	Payload 변수 이름

요청 예시

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

curl -X POST '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" : "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": "PUB",
    "modTime": "2024-05-03T01:26:57Z"
}