API 키 구성 - 토큰 기반 인증

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기3분

    • REST API 엔드포인트에 대한 인증을 지원하도록 API 키를 구성합니다.

    시작하기 전에

    필요한 역할: admin

    필요한 플러그인: API 키 및 HMAC 인증(com.glide.tokenbased_auth)

    프로시저

    1. 인바운드 인증 프로파일을 생성합니다.
      1. 다음으로 이동 모두 > 시스템 웹 서비스 > API 접근 정책 > 인바운드 인증 프로파일.
      2. 새로 만들기를 선택합니다.
        시스템에 What kind of authentication profile?(어떤 종류의 인증 프로파일입니까?) 메시지가 표시됩니다.
      3. API 키 인증 프로필 만들기를 선택합니다.
        API 키 인증 프로파일
      4. 양식의 필드에 내용을 입력합니다.
        표 1. API 키 인증 프로파일
        필드 설명
        이름 인증 정책을 식별하기 위한 이름입니다.
        애플리케이션 인증 정책의 범위입니다.
        인증 매개변수 인증 요청에 대한 인증 매개변수를 선택합니다. 기본 옵션을 선택하거나 새 인증 매개변수를 만들 수 있습니다.
        • x-sn-apikey: 인증 헤더
        • x-sn-apikey: 쿼리 매개변수 헤더
        주:
        선택한 옵션은 REST 호출에서 인증 헤더 또는 쿼리 매개변수의 일부로 정의되어야 합니다.
        API 매개변수
      5. 양식을 제출합니다.
    2. REST API 키를 생성합니다.
      1. 다음으로 이동 모두 > 시스템 웹 서비스 > API 접근 정책 > REST API 키.
      2. 새로 만들기를 선택합니다.
      3. 양식에서 필드에 다음을 입력합니다.
        표 2. API 키
        필드 설명
        이름 REST API 키를 식별하기 위한 이름
        설명 REST API 키에 대한 설명입니다.
        활성 REST API 키의 상태입니다.
        사용자 REST API 키와 연결된 사용자입니다. 조회 아이콘을 사용하여 사용자를 선택합니다.
        인증 범위 REST API 키의 권한을 관리하기 위해 인증 범위를 추가하는 옵션입니다.
        토큰 에 의해 생성된 REST API 키입니다 Now Platform. 헤더 또는 쿼리 매개변수 내에서 REST API 호출의 일부로 사용할 키를 복사합니다.
        만료 자격 증명이 더 이상 유효하지 않게 되는 시간입니다. 값이 비어 있으면 만료되지 않습니다.
        주:
        토큰 만료에 대한 자세한 내용은 을 참조하십시오 토큰 만료 정리 중 .
      4. 양식을 제출합니다.
      5. 생성된 기록을 열어 사용자에 대해 생성된 토큰을 봅니다 Now Platform .
        API 토큰
    3. REST API 액세스 정책을 생성합니다.
      1. 다음으로 이동 모두 > 시스템 웹 서비스 > REST API 접근 정책.
      2. 새로 만들기를 선택합니다.
      3. 양식의 필드에 내용을 입력합니다.
        표 3. API 접근 정책
        필드 설명
        이름 API 액세스 정책의 고유한 이름입니다.
        활성 API 액세스 정책을 활성화하는 옵션입니다.
        REST API 액세스 정책이 적용되는 REST API입니다. 예를 들어, 첨부 파일 API입니다.
        REST API 경로 REST API의 API 경로입니다. 이 필드는 선택한 REST API에 따라 자동으로 채워집니다. 예: now/attachment.
        HTTP 메서드 API와 상호작용하는 데 사용되는 메서드입니다. 이 필드는 선택한 REST API에 따라 자동으로 채워집니다.
        버전 API의 버전입니다. 예: v1. 이 필드는 선택한 REST API에 따라 자동으로 채워집니다.
        주:
        REST API의 모든 버전에 대한 인증 정책을 만들려면 각 버전에 대해 개별 정책을 만들어야 합니다.
        자원 REST API의 하위 자원입니다. 이 필드는 선택한 REST API에 따라 자동으로 채워집니다. 예: /now/attachment
        애플리케이션 애플리케이션의 범위입니다.
        전역 API에 대한 모든 메서드, 버전 및 자원에 인증 정책을 적용하려면 이 필드를 활성화합니다.
        주:
        토큰 기반 인증은 전역 REST API 정책에서 허용되지 않습니다.
        모든 메서드에 적용 API에 대한 인증 정책을 API의 모든 메서드, 버전 및 자원에 적용하려면 이 필드를 활성화합니다.
        모든 자원에 적용 API에 대한 인증 정책을 모든 버전에 적용하려면 이 필드를 활성화합니다.
        모든 버전에 적용 API에 대한 인증 정책을 모든 자원에 적용하려면 이 필드를 활성화합니다.
        액세스 정책에 프로파일 추가
      4. 생성된 API 인증 프로파일을 추가합니다.
      5. 양식을 제출합니다.
      인증 구성에 따라 헤더 또는 쿼리 매개변수 내에서 API 키 생성 중에 생성된 Now Platform x-sn-apikey(토큰)를 사용하여 REST API 호출을 보낼 수 있습니다.
      경고:
      중요한 정보를 서버에 제출할 때 POST 요청을 사용합니다.