사용자 키 관리

본 장에서는 AnyAPI WebAdmin의 [Operation] 메뉴에서 사용자 키를 관리하는 방법에 대해 설명합니다.

사용자 키 목록 조회

등록된 사용자 키 목록을 조회할 수 있습니다.

  1. AnyAPI WebAdmin의 메뉴 영역에서 [Operation] > [Authentication/…] 메뉴를 선택합니다.

  2. Auth 화면이 열리면 [User Key] 영역의 'User Key List Table’에서 등록된 사용자 키 목록을 조회할 수 있습니다. 이때 figure refresh icon 버튼을 클릭하면 새로고침되어 최신 정보를 조회할 수 있습니다.

    figure user key list

    조회 항목에 대한 설명은 다음과 같습니다.

    항목 설명

    User Key ID

    사용자 키의 ID입니다.

    User Key Name

    사용자 키의 이름입니다.

    Description

    사용자 키에 대한 설명입니다.

    Role

    사용자 키에 할당된 인증 역할의 이름입니다.

    Created At

    사용자 키가 생성된 날짜와 시간입니다.

    1. 'Search' 입력란에 검색어를 입력하면 모든 조회 항목의 값을 대상으로 검색어가 포함된 목록만 조회할 수 있습니다.

    2. figure show column icon 버튼을 클릭하면 목록에 표시할 항목을 선택할 수 있습니다. 이때 체크박스가 선택된 항목들은 표시되고, 체크박스가 해제된 항목들은 표시되지 않습니다.

사용자 키 생성

새로운 사용자 키를 생성할 수 있습니다.

  1. AnyAPI WebAdmin의 메뉴 영역에서 [Operation] > [Authentication/…] 메뉴를 선택합니다.

  2. Auth 화면이 열리면 [User Key] 영역의 목록에서 figure api create icon 버튼을 클릭합니다.

    figure user key create button click

  3. 시스템에서 자동으로 사용자 키 ID를 부여하여 새로운 사용자 키를 생성합니다.

사용자 키 상세 정보 조회

사용자 키의 정보를 상세하게 확인할 수 있습니다.

  1. AnyAPI WebAdmin의 메뉴 영역에서 [Operation] > [Authentication/…] 메뉴를 선택합니다.

  2. Auth 화면이 열리면 [User Key] 영역의 목록에서 상세 정보를 확인할 사용자 키를 클릭합니다.

    figure user key list click

  3. 해당 사용자 키의 상세 정보 화면이 열리면 원하는 정보를 확인할 수 있습니다.

    figure user key detail

    또한 화면 오른쪽 하단의 figure api edit icon 버튼을 클릭하면 수정 모드로 전환되어 정보를 수정할 수 있습니다.

    각 설정 항목에 대한 자세한 설명은 사용자 키 설정 항목을 참고합니다.

인증 및 접근 제어 설정

인증 역할 할당

사용자 키에 하나의 인증 역할을 할당할 수 있습니다. 단, 인증 정책이 할당된 인증 역할만 가능합니다.

  1. AnyAPI WebAdmin의 메뉴 영역에서 [Operation] > [Authentication/…] 메뉴를 선택합니다.

  2. Auth 화면이 열리면 [User Key] 영역의 목록에서 역할을 할당할 사용자 키를 클릭합니다.

    figure user key list click

  3. 해당 사용자 키의 상세 정보 화면이 열리면 figure api edit icon 버튼을 클릭합니다.

    figure user key edit icon click

  4. 수정 모드로 전환되면 'Role' 항목의 입력란을 클릭합니다.

    figure user key edit role add

  5. '인증 역할 목록' 다이얼로그 박스가 열리면 할당할 역할의 체크박스를 클릭한 후 [Select] 버튼을 클릭합니다.

    figure user key edit role list

  6. 선택한 역할이 정상적으로 'Role' 항목의 입력란에 표시되면 figure save icon 버튼을 클릭합니다.

  7. '수정 확인' 대화상자가 열리면 [확인] 버튼을 클릭합니다.

블랙 리스트 추가

해당 사용자 키를 포함한 요청 중에서 거부할 IP 주소와 헤더/바디 정보를 설정할 수 있습니다.

  1. AnyAPI WebAdmin의 메뉴 영역에서 [Operation] > [Authentication/…] 메뉴를 선택합니다.

  2. Auth 화면이 열리면 [User Key] 영역의 목록에서 블랙 리스트를 추가할 사용자 키를 클릭합니다.

    figure user key list click

  3. 해당 사용자 키의 상세 정보 화면이 열리면 figure api edit icon 버튼을 클릭합니다.

    figure user key edit icon click

  4. 수정 모드로 전환되면 'Blacklist IP' 항목에서 거부할 IP 주소 정보를 추가할 수 있고, 'Blacklist Header/Body' 항목에서 거부할 헤더/바디 정보를 추가할 수 있습니다.

    이때 figure response header create icon 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 figure response header save icon 버튼을 클릭하면 정보가 추가됩니다.

    figure user key edit blacklist add

  5. 블랙 리스트 정보 추가가 모두 완료되면 화면 오른쪽 하단의 figure save icon 버튼을 클릭합니다.

  6. '수정 확인' 대화상자가 열리면 [확인] 버튼을 클릭합니다.

화이트 리스트 추가

해당 사용자 키를 포함한 요청 중에서 허용할 IP 주소와 헤더/바디 정보를 설정할 수 있습니다.

  1. AnyAPI WebAdmin의 메뉴 영역에서 [Operation] > [Authentication/…] 메뉴를 선택합니다.

  2. Auth 화면이 열리면 [User Key] 영역의 목록에서 화이트 리스트를 추가할 사용자 키를 클릭합니다.

    figure user key list click

  3. 해당 사용자 키의 상세 정보 화면이 열리면 figure api edit icon 버튼을 클릭합니다.

    figure user key edit icon click

  4. 수정 모드로 전환되면 'Whitelist IP' 항목에서 허용할 IP 주소 정보를 추가할 수 있고, 'Whitelist Header/Body' 항목에서 허용할 헤더/바디 정보를 추가할 수 있습니다.

    이때 figure response header create icon 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 figure response header save icon 버튼을 클릭하면 정보가 추가됩니다.

    figure user key edit whitelist add

  5. 화이트 리스트 정보 추가가 모두 완료되면 화면 오른쪽 하단의 figure save icon 버튼을 클릭합니다.

  6. '수정 확인' 대화상자가 열리면 [확인] 버튼을 클릭합니다.

사용자 키 삭제

사용하지 않는 사용자 키를 삭제할 수 있습니다.

  1. AnyAPI WebAdmin의 메뉴 영역에서 [Operation] > [Authentication/…] 메뉴를 선택합니다.

  2. Auth 화면이 열리면 [User Key] 영역의 목록에서 삭제할 사용자 키의 체크박스 선택한 후 figure api del icon 버튼을 클릭합니다.

    figure user key del button click

  3. '삭제 확인' 대화상자가 열리면 [Yes] 버튼을 클릭합니다.