Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

인증 제공자(AuthenticationProvider) API (V2)

AuthenticationProvider는 Foundry 플랫폼 인스턴스에 로그인할 SSO 제공자의 설정 리소스입니다. 이 API는 SAML과 OIDC 프로토콜을 다룹니다.

설정 정보 조회

List Authentication Providers는 플랫폼 인스턴스의 제공자 목록을, Get Authentication Provider는 RID로 지정한 제공자 하나를 조회합니다.

필드의미와 조건
rid필수 인증 제공자 리소스 RID
name필수 제공자 이름
realm필수 인증 영역 식별자
enabled필수 boolean, 이 제공자를 통한 로그인 사용 여부
supportedHosts선택 호스트 목록, 해당 제공자를 사용할 수 있는 호스트
supportedUsernamePatterns선택 사용자 이름 패턴 목록, 일치하는 이름은 해당 제공자로 리디렉션
protocol필수 프로토콜 정보, type으로 saml 또는 oidc 구분

호스트, 사용자 이름 패턴과 로그인 활성화 여부는 서로 다른 설정입니다. 제공자의 rid는 외부 사용자의 providerId와 다른 식별자입니다.

프로토콜별 응답

protocol.type="saml"에는 필수 serviceProviderMetadata가 있습니다. Foundry가 SAML 서비스 제공자(SP)로서 생성한 메타데이터이며 외부 인증 제공자(IdP)와 연결할 때 사용합니다.

SAML 메타데이터조건과 역할
entityId필수, 고정 SAML 서비스 제공자 엔터티 ID
metadataUrl필수, XML 메타데이터를 다운로드하는 공개 URL
acsUrls선택, IdP가 인증 응답을 보내는 Assertion Consumer Service URL 목록
logoutUrls선택, IdP가 로그아웃 요청을 보내는 URL 목록
certificates선택, 인증서 정보 목록

각 CertificateInfo에는 필수 pemCertificate, expiryDate, usageType과 선택 commonName이 있습니다. 인증서는 PEM 형식이며 사용 유형은 ENCRYPTION, SIGNING, UNSPECIFIED 중 하나입니다. 실제 구성에는 Foundry가 생성한 메타데이터와 인증서를 사용합니다.

protocol.type="oidc" 분기의 이 응답 모델에는 type 외의 추가 필드가 없습니다.

첫 로그인 전 사전 등록

Preregister User는 사용자가 해당 제공자로 처음 로그인하기 전에 사용자를 등록합니다. 사용자 이름은 제공자의 지원 패턴과 일치해야 하며 기본 조직 RID도 필요합니다. 첫 로그인 때 조직 할당 규칙에 따라 기본 조직이 바뀔 수 있습니다. 사전 등록한 사용자는 첫 로그인 전에도 그룹과 역할을 할당할 수 있습니다.

Preregister Group은 해당 그룹 정보를 가진 사용자가 로그인하기 전에 그룹을 등록합니다. 등록한 그룹은 플랫폼의 다른 그룹처럼 사용할 수 있습니다.

두 사전 등록 API는 생성한 주체의 PrincipalId 문자열을 반환합니다.

권한과 지원 단계

이 네 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 호출할 때 preview=true를 지정합니다. 조회에는 api:admin-read, 사전 등록에는 api:admin-write OAuth 권한 범위를 요청합니다.

로그인 시 외부 식별자를 연결하는 저장 정보는 UserProviderInfo와 GroupProviderInfo로 조회하거나 교체합니다.