Authorizer 목록 조회

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

Authorizer의 목록을 조회합니다.

요청

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

메서드	URI
GET	/authorizers

요청 헤더

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

요청 쿼리 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`offset`	Long	Optional	조회할 데이터 목록에서 시작할 위치 0~9,223,372,036,854,775,807
`limit`	Long	Optional	한 번에 조회할 데이터 개수 1~9,223,372,036,854,775,807
`name`	String	Optional	Authorizer 이름으로 필터링 0~20

요청 예시

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

curl -X GET '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}'

응답

응답 형식을 설명합니다.

응답 구문

구문은 다음과 같습니다.

{
    "authorizers": [
        {
            "authorizerId": "authorizerId",
            "authorizerName": "authorizerName",
            "authorizerDescription": "authorizerDescription"
        }
    ],
    "total": 0,
    "initialCount": 0
}

응답 상태 코드

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

응답 예시

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

{
    "authorizers": [
        {
            "authorizerId": "***gct7vcr",
            "authorizerName": "authorizer-****",
            "authorizerDescription": "authorizer-**** Description"
        }
    ],
    "total": 1,
    "initialCount": 1
}