기본 인증 보안 스킴 컴포넌트 정의

온라인에서 편집하기

API를 호출하는 애플리케이션이 사용자 레지스트리를 통하여 인증해야 하면 기본 인증 보안 스킴 컴포넌트가 사용됩니다.

시작하기 전에

게이트웨이에서 적용되는 API 작업에 대한 액세스 인증을 위해 다음 사용자 레지스트리 유형이 지원됩니다:
  • 인증 URL
  • LDAP
다음 사용자 레지스트리 유형은 지원되지 않습니다 .
  • OpenID Connect(OIDC)
  • LUR(Local User Registry)
  • 사용자 정의 사용자 레지스트리

API에서 기본 인증 보안 정의를 작성하기 전에 사용자 레지스트리가 존재해야 합니다. 사용자 레지스트리를 작성하기 위해 API Manager 또는 Cloud Manager를 사용할 수 있습니다. API Manager에서 레지스트리를 작성하면 제공자 조직에만 표시됩니다. Cloud Manager에서 레지스트리를 작성할 때 여러 제공자 조직에 표시되도록 할 수 있습니다.

API Manager를 사용하여 사용자 레지스트리를 작성하려면 사용자 레지스트리에 대한 작업을 참조하십시오.

이 태스크에 대한 정보

참고:
  • 이 태스크는 OpenAPI 3.0 API 정의 구성과 관련이 있습니다. OpenAPI 2.0 API 정의를 구성하는 방법에 대한 세부사항은 OpenAPI 2.0 API 정의 편집을 참조하십시오.
  • OpenAPI 3.0 API는 DataPower Gateway (v5 compatible)가 아닌 DataPower® API Gateway에서만 지원됩니다.
  • 현재 OpenAPI 3.0 지원 제한사항에 대한 세부사항은 IBM® API Connect 의 OpenAPI 3.0 지원의 내용을 참조하십시오.

API Designer UI 애플리케이션을 사용하거나 브라우저 기반 API Manager UI를 사용하여 이 태스크를 완료할 수 있습니다.

기본 인증을 사용하는 경우 API 사용자가 선택한 오퍼레이션에 액세스할 수 있는 사용자 이름 및 비밀번호를 제공해야 합니다. 애플리케이션 개발자도 기본 인증이 필요한 오퍼레이션으로 보내는 요청에서 HTTP 권한 부여 헤더를 제공해야 합니다.

인증 URL을 사용할 때, 권한부여 헤더에서 제공되는 사용자 신임 정보는 URL에서 지정되는 엔드포인트에 의해 유효성 검증됩니다. 사용자가 인증된 경우, ` IBM API Connect `는 인증된 ` URL `를 받아 ` HTTP `를 반환합니다200 OK응답 상태 코드입니다. 다른 모든 HTTP 인증 상태 코드는 인증 실패이며 액세스가 거부됩니다.

LDAP 사용자 레지스트리를 이용한 인증에 대한 자세한 내용은 LDAP authentication을 참조하십시오.

인증 사용자 레지스트리 ( URL ) 사용에 대한 자세한 내용은 인증 사용자 레지스트리( URL )를 참조하십시오.

기본 인증 보안 스킴 컴포넌트를 사용하려면 API 정의의 다른 곳으로부터 참조해야 합니다. 자세한 내용은 ‘API에 대한 보안 요구 사항 적용’ 및 ‘작업에 대한 보안 요구 사항 적용’을 참조하세요.

언제든지 소스 아이콘을 클릭하면 기본 OpenAPI 소스 아이콘OpenAPI YAML 소스 파일로 바로 전환할 수 있습니다. 양식 화면으로 돌아가려면 양식 아이콘을 클릭하세요 양식 아이콘.

프로시저

  1. OpenAPI 3.0 API 정의 편집에 설명된 대로 편집할 API를 여십시오.
  2. 구성요소 를 펼친 후, 이미 하나 이상의 보안 스킴 구성요소가 정의되어 있는 경우 보안 스킴을 펼치십시오.
  3. 기본 인증 보안 구성 요소를 생성하려면 ‘보안 구성’ 옆의 추가 OpenAPI 3.0 API 추가 아이콘 아이콘을 클릭하세요. 기존 기본 인증 보안 스킴 컴포넌트를 편집하려면 탐색 분할창에서 컴포넌트 이름을 클릭하십시오.
  4. 새 기본 인증 보안 스킴 컴포넌트를 작성 중인 경우, 처음부터 작성하거나 다른 기본 인증 보안 스킴 컴포넌트를 참조할 수 있습니다.
    처음부터 기본 인증 보안 스킴 컴포넌트를 작성하려면 정의 탭에 다음 정보를 제공하십시오.
    • 보안 스킴 이름(필수): 이 기본 인증 보안 스킴 컴포넌트가 API 정의의 다른 곳으로부터 참조할 수 있게 하는 키입니다. 참조의 형식은 다음과 같습니다.
      #/components/securitySchemes/Security_Scheme_Name
    • 보안 스킴 유형 (필수): http를 선택하십시오.
    • 스키마 (필수): RFC7235 에 정의된 대로 Authorization 헤더에 사용될 HTTP 인증 스키마의 이름입니다.
    • 사용자 레지스트리를 사용하여 인증: 인증에 사용될 사용자 레지스트리의 이름입니다. 사용자 레지스트리가 작성되었을 때 자동 생성된 name 필드의 값입니다.
    • 전달자 포맷: 전달자 토큰의 형식 지정 방법을 식별하기 위해 클라이언트에 대한 힌트입니다. 전달자 토큰은 보통 권한 서버에서 생성되므로 이 정보는 주로 문서화 용도입니다.
    • 설명: 기본 인증 보안 스킴에 대한 선택적 설명입니다. 서식 있는 텍스트를 표현하려면 CommonMark 구문을 사용할 수 있습니다.
    다른 기본 인증 보안 스킴 컴포넌트를 참조하려면 참조 탭에 다음 정보를 제공하십시오.
    • 보안 스킴 이름(필수): 이 기본 인증 보안 스킴 컴포넌트가 API 정의의 다른 곳으로부터 참조할 수 있게 하는 키입니다. 참조의 형식은 다음과 같습니다.
      #/components/securitySchemes/Security_Scheme_Name
    • 다음에서 참조: 다른 기본 키 인증 보안 스킴 컴포넌트에 대한 참조를 선택하십시오.
  5. 새 기본 인증 보안 스킴 컴포넌트를 작성하는 경우 작성을 클릭하십시오.
    보안 스킴 컴포넌트 세부사항은 추가 편집을 위해 표시됩니다.
  6. 완료되면 저장 을 클릭하십시오.

다음에 수행할 작업

보안 스킴을 API나 오퍼레이션에 적용하십시오. 자세한 내용은 ‘API에 대한 보안 요구 사항 적용’ 및 ‘작업에 대한 보안 요구 사항 적용’을 참조하세요.

LDAP 및 인증( URL )에 대한 자세한 내용은 LDAP authentic ation과 사용자 레지스트리( URL )를 참조하십시오.