Cato API에 대한 API 키 생성

두 가지 유형의 API 키에 대한 개별 CMA 페이지가 있습니다.

API 키 - 개인용 관리자 사용
서비스 키 - 다른 서비스 기본 사용자 간의 공유 사용

개요

Cato는 Cato Management Application(CMA)에서 API 키를 생성하여 Cato API 서버에 대한 API 호출을 인증하는 데 사용하도록 합니다. API 클라이언트, 코드, 스크립트, Terraform, SIEM 통합, MCP 등과 안전하게 상호작용하기 위해 API 키를 입력하십시오.

다음은 API 키의 유형입니다.

관리자 API 키는 관리자 계정에 연결된 개인 키로, 자신의 API 워크플로에 사용됩니다. 관리자 API 키는 개인용으로만 생성할 수 있습니다. 자세한 정보는 아래 관리자 API 키를 참조하십시오.
서비스 API 키는 시스템 프로세스, 자동화 또는 타사 통합에 의해 사용되는 공유 키입니다. 이 키는 개인 관리자 로그인과 연결되지 않으며 운영 사용 사례에 가장 적합합니다. 자세한 정보는 아래 서비스 기본 사용자 API 키를 참조하십시오.

Cato는 두 가지 수준의 API 호출에 대한 세부적인 지원을 제공합니다.

질의 API - 계정의 데이터를 검색하기 위한 읽기 전용 API 호출 수행

Viewer 권한은 질의 API 호출만 실행할 수 있도록 허용합니다. 역할을 통해 권한이 할당되었거나 특정 CMA 페이지로 제한되었는지 여부에 관계없이 적용됩니다.
구성 API - 계정의 구성 변경을 수행하기 위한 쓰기 API 호출

Edit 권한은 구성 또는 질의 API 호출만 실행할 수 있도록 허용합니다. 역할을 통해 권한이 할당되었거나 특정 CMA 페이지로 제한되었는지 여부에 관계없이 적용됩니다.

API 클라이언트에 API 키 장치 추가

Cato API에 요청을 인증하려면 API 클라이언트에 x-api-key라는 이름의 HTTP 헤더를 포함하세요. 이 헤더의 값을 x-api-key: <api-key> 형식을 사용하여 Cato API 키로 설정합니다. 예: x-api-key: abcdef12345입니다. 이 헤더는 요청을 승인하고 키와 연관된 권한에 따라 관련 Cato API 엔드포인트에 대한 액세스를 허용합니다.

서비스 Principal 관리자

서비스 프린시플 관리자는 API 기반 워크플로를 위해 특별히 생성된 CMA 관리자의 특별한 유형입니다. 시스템 통합 및 자동화 프로세스를 안전하게 지원하려면 계정에 대한 서비스 프린시플 관리자를 생성하십시오. 이를 통해 개인 로그인 자격 증명과 연결되지 않은 API 키를 생성할 수 있으며 CMA에 액세스하는 데 사용될 수 없습니다.

서비스 프린시플 관리자 자격 증명은 해당 서비스 API 키와 함께 API 인증을 위해 독점적으로 사용됩니다. 이 설정은 보안을 강화하고 자동 운영에 대한 책임 분리를 강화합니다.

참고: 새로운 CMA 관리자로 Automation Service Principal (편집자)의 이름이 생성 시간 기존 계정에 서비스 Principal API 키 장치 추가 부분으로 자동으로 생성됩니다.

서비스 프린시플 관리자를 생성하려면

탐색 메뉴에서 계정 > 관리자를 클릭합니다.
새로 만들기를 클릭하세요.

관리자 생성 패널이 열립니다.
새로 만들기 및 서비스 프린시플로 생성을 선택합니다.
관리자에 대한 일반 설정을 입력합니다.
이 관리자의 권한을 정의할 역할과 특정 사이트 및 사용자를 선택합니다. 역할에 대해 알아보려면 역할 관리를 참조하십시오.

이러한 권한은 서비스 프린시플 API 키에 적용됩니다.
적용을 클릭하세요. 관리자가 관리자 페이지에 추가되며 서비스 프린시플 관리자가 자동으로 활성화됩니다.

API 키 AI 요약 생성 중

API 키 및 서비스 API 키 페이지를 통해 API 키를 생성하고 해제할 수 있습니다. API 키의 이름은 각 키를 식별하기 위한 것으로 인증 과정의 일부로 사용되지는 않습니다.

추가 보안을 위해 API 및 서비스 API 키의 소스 IP 또는 IP 범위(CIDR)를 제한할 수 있습니다.

참고: 팝업 창에서 API 키 값을 반드시 복사하십시오. 팝업 창을 닫으면 키 값을 다시 접근할 수 없습니다.

관리자 API 키

개별 관리자로서 자신의 자동화 워크플로를 지원해야 할 때, CMA 관리자의 자격 증명과 연결된 관리자 API 키를 생성하십시오. 자신의 사용을 위해서만 관리자 API 키를 생성할 수 있으며 다른 관리자에 대해 또는 CMA를 통해서만 생성할 수 없습니다.

관리자가 삭제되면 관련된 API 키가 자동으로 비활성화됩니다. 관리자가 비활성화되면 키는 비활성화됨으로 표시되며 이를 사용한 API 호출은 오류가 반환됩니다.

관리자 API 키에 대한 RBAC 권한

각 관리자 API 키는 생성한 관리자의 RBAC 권한과 역할을 상속받습니다. 관리자의 RBAC 역할이 변경되면 특정 사이트, 사용자 그룹, 그룹 등에 대한 권한을 포함하여 권한이 동적으로 업데이트됩니다.
Viewer 역할을 가진 관리자들은 모든 API 키 정보를 볼 수 있으며 (실제 키 값 제외)
API 키 페이지를 포함하는 RBAC 역할의 Editor를 가진 관리자들은 계정 내 API 키를 확인하고 또한 해제(삭제)할 수 있습니다.

관리자 API 키를 생성하려면

네비게이션 메뉴에서 자원 > 관리자 API 키를 클릭합니다.
새로 만들기를 클릭합니다. API 키 생성 패널이 열립니다.
키 이름을 입력하세요.
이 키에 보기 전용 권한을 적용하려면, 보기로 다운그레이드를 선택합니다.
(선택 사항) 추가 보안을 위해 IP에서 액세스 허용에서 특정 IP 목록을 선택하고 사용할 IP 주소 또는 IP 범위를 정의하세요.

기본 설정은 모든 IP 주소에 대해 이 API 키를 허용하는 것입니다.
(선택 사항) API 키의 만료일을 선택하세요.

편집 권한이 있는 API 키의 경우, 만료일을 설정하는 것이 좋습니다.
적용을 클릭합니다. API 키가 페이지에 추가되며 새 API 키의 값을 포함한 팝업 창이 표시됩니다.
CMA에 의해 생성된 API 키를 복사하여 안전한 장소에 저장하기 위해 버튼을 클릭합니다.

이 창을 닫으면 API 키의 값을 다시 액세스할 수 없습니다.
팝업 창을 닫으려면 확인을 클릭하세요.

서비스 Principal API 키

공유 운영 또는 통합 워크플로를 지원해야 할 때, 서비스 API 키 페이지에서 서비스 API 키를 생성하십시오. 이러한 키는 CMA 접근이 필요하지 않은 자동화 서비스와 스크립트에 사용하기 위해 설계되었습니다. 이들은 키를 생성한 서비스 주체 관리자에 연결되어 있습니다.

서비스 API 키는 시스템 및 팀 간에 사용될 수 있으며 외부 도구 및 서비스와의 스케일 가능한 통합을 가능하게 합니다. 이러한 유형의 키는 CMA 관리자와 연결되지 않으며 백엔드 운영 또는 지속적인 전달 파이프라인을 위해 의도됩니다.

서비스 API 키에 대한 RBAC 권한

Editor 역할만 가진 관리자가 서비스 프린시플 API 키를 생성하거나 관리할 수 있습니다.
각 서비스 API 키는 키에 연결된 서비스 프린시플 관리자의 RBAC 권한과 역할을 상속받습니다. 관리자의 RBAC 권한이 변경되면 서비스 프린시플 API 키는 자동으로 새로운 권한으로 업데이트됩니다.

서비스 API 키를 생성하려면:

네비게이션 메뉴에서 자원 > 서비스 API 키를 클릭합니다.
새로운을 클릭합니다. API 키 생성 패널이 열립니다.
이 키와 관련된 서비스 주체를 선택합니다.
키 이름을 입력하십시오.
이 키에 보기 전용 권한을 적용하려면, 보기로 다운그레이드를 선택합니다.
(선택사항) 추가 보안을 위해, IP에서 접근 허용에서 특정 IP 목록을 선택하고 이 API 키를 사용할 수 있는 IP 주소 또는 IP 범위를 정의합니다.

기본 설정은 모든 IP 주소에 대해 이 API 키를 허용하는 것입니다.
(선택사항) API 키가 만료될 날짜를 선택합니다.

편집 권한이 있는 API 키의 경우, API 키가 만료될 날짜를 설정할 것을 권장합니다.
적용을 클릭합니다. API 키가 페이지에 추가되며 새로운 API 키의 값을 포함하는 팝업 창이 표시됩니다.
버튼을 클릭하여 CMA에서 생성된 API 키를 복사하여 안전한 위치에 저장합니다.

이 창을 닫으면 API 키의 값을 액세스할 수 없습니다.
팝업 창을 닫기 위해 확인을 클릭합니다.

API 키 취소

API 키를 해제하고 CMA에서 삭제할 수 있습니다. 일단 해지되면, 키는 API 서버에 인증하는 데 사용할 수 없습니다.

API 키를 해지하려면:

네비게이션 메뉴에서 자원 > 관리자 API 키 또는 서비스 API 키를 클릭합니다.
API 키가 있는 행에서 행 끝의 삭제 아이콘을 클릭합니다.
확인 창에서 삭제를 클릭하세요. API 키가 해지되고 계정에서 제거됩니다.