기본 콘텐츠로 건너뛰기

API 키 관리

API 키는 사용자 인증, 개발자 인증 또는 API로 프로그램을 호출하는 데 사용되는 고유한 식별자입니다. API 키는 API의 남용을 방지하기 위해 인터페이스 사용 방법을 추적하고 제어하는 데 자주 사용됩니다.

API 키 개요

기본적으로 API 키는 관리 콘솔에서 비활성화됩니다. API 키를 활성화하려면 설정 섹션으로 이동합니다. 테넌트 관리자는 API 키를 취소하고 API 키 설정을 편집할 수 있지만 API 키를 생성하거나 삭제하려면 개발자 역할이 있어야 합니다. 테넌트 관리자는 사용자에게 개발자 역할을 할당합니다. 테넌트 관리자는 본인에게 개발자 역할을 할당할 수 있습니다.

API 키 테이블에는 API 키의 이름, ID, 소유자, 마지막 업데이트, 생성 날짜, 만료 날짜 및 상태에 대한 정보가 표시됩니다. 처음 세 개 필드인 키 이름, 키 ID소유자를 검색하려면 검색 필드를 사용합니다.

API 키 상태

API 키 상태는 다음과 같습니다.

  • 활성: API 키가 사용 중입니다.
  • 만료됨: 만료 날짜에 도달했습니다.
  • 취소됨: API 키가 취소되어 더 이상 사용할 수 없습니다.

관리자는 관리 콘솔이벤트 섹션에서 등록된 API 키 활동을 검토할 수 있습니다. 특정 API 키가 과도하게 사용되는 등 의심스러운 활동이 탐지되면 해당 API 키를 취소할 수 있습니다. 테이블 맨 오른쪽의 화살표를 클릭하여 상세 목록을 열고 API 키의 ID를 복사합니다. 그런 다음 API 키 섹션에서 ID를 검색하면 취소할 API 키를 찾을 수 있습니다.

단일 API 키를 취소하려면 맨 오른쪽의 ... 버튼을 클릭하고 취소를 선택합니다. 활성 상태의 키만 취소할 수 있습니다. 여러 키를 취소하려면 취소할 키 왼쪽의 확인란을 선택하고 오른쪽 위 모서리에 있는 취소를 클릭합니다. 취소는 되돌릴 수 없으며 취소된 API 키는 다시 활성화할 수 없습니다.

취소 외에 삭제 옵션도 있습니다. 허브에서 API 키를 삭제할 수 있지만 관리 콘솔에서는 삭제할 수 없습니다.

테넌트에서 API 키 활성화

API 키 활성화 설정은 관리 콘솔설정 페이지에서 설정됩니다. 기본적으로 API 키는 관리 콘솔에서 비활성화됩니다.

API 키에 대한 속성
속성 설명
API 활성화

이 속성은 테넌트의 모든 API 키를 활성화 또는 비활성화 간에 전환합니다. 테넌트 관리자만 API 키를 활성화할 수 있습니다.

최대 토큰 만료 변경

토큰 만료 값을 변경하면 모든 새 토큰이 새 만료 값을 갖게 됩니다. 기존의 API는 이러한 변경에 영향을 받지 않으므로 만료 값은 이전과 동일합니다.

사용자당 최대 API 키 수 변경

이 설정은 새 API 키에만 영향을 줍니다. 새 API 키의 총 수가 최대 수를 초과할 경우 생성이 거부됩니다.

다음과 같이 하십시오.

  1. 관리 콘솔에서 설정 페이지로 이동합니다.
  2. API 키 섹션에서 API 키 활성화 버튼을 누릅니다.
  3. 해당되는 경우, 최대 토큰 만료 변경사용자당 최대 API 키 변경 설정을 변경합니다.

허브에서 API 키 생성

허브에서 API 키를 생성할 수 있습니다. 시작하기 전에 다음 두 가지 요구 사항을 충족하는지 확인합니다.

  • 관리 콘솔에서 API 활성화 설정을 켭니다.
  • 테넌터 관리자가 개발자 역할을 할당했습니다.

다음과 같이 하십시오.

  1. 테넌트(예: https://<tenantname>.com)에 로그온합니다.

  2. 오른쪽 위 모서리에서 프로필을 클릭하고 프로필 설정을 선택합니다.

  3. API  키를 선택합니다.

  4. 새 키 생성을 클릭합니다.

  5. API 키 설명을 입력하고 API 키 만료 시점을 선택합니다.

  6. 생성을 클릭합니다.

    API 키가 생성됩니다.

  7. API 키를 복사하여 안전한 곳에 저장합니다.

API 키를 생성한 후 이름을 편집할 수 있습니다. 키를 삭제할 수도 있습니다.