공개 미리 보기: 피드백 제공하세요: 지정된 연합에서 ID 제공자 한 개를 업데이트합니다.
공개 미리 보기: MongoDB Atlas 관리자 API 에서 자동으로 생성된 Atlas API 하위 명령은 관리자 API 에 대한 전체 기능을 제공하며 현재 공개 미리 보기로 제공됩니다( 피드백 https://feedback.mongodb.com/forums/930808-Atlas-cli). 관리자 API 기능에는 자체 출시하다 수명 주기가 있으며, 이는 제공된 API 엔드포인트 문서 링크를 통해 확인할 수 있습니다.
이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 연결된 조직 중 하나의 조직 소유자 역할이 있어야 합니다.
참고: 권한 부여 유형을 변경하거나 권한 부여 클레임을 업데이트하면 현재 사용자 및/또는 그룹이 데이터베이스 액세스하지 못할 수 있습니다.
이 명령은 자동으로 생성되며 1:1 Atlas API 엔드포인트 https://www.mongodb.com/ko-kr/docs/api/doc/atlas-admin-api-v2/operation/operation-updateidentityprovider에 해당합니다. .
자세한 내용과 예시는 위에 링크된 참조 API 문서를 참조하세요.
구문
atlas api federatedAuthentication updateIdentityProvider [options]
옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
--envelope | envelope | 거짓 | 애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다. |
--federationSettingsId | 문자열 | true | 연합을 식별하는 고유한 24자리 16진수 문자열. |
--file | 문자열 | 거짓 | API 요청 파일 의 경로입니다. 표준 입력을 대신 사용하려면 비워 두세요 - 둘 중 하나를 제공해야 하지만 둘 다 제공할 수는 없습니다. |
-h, --help | 거짓 | updateIdentityProvider에 대한 도움말 | |
--identityProviderId | 문자열 | true | 연결할 멱등을 식별하는 고유 문자열입니다. 2023년 11월 15일 이전의 API 버전을 사용하는 경우 레거시 20자리 16진수 ID를 사용합니다. 이 ID는 페더레이션 관리 콘솔 > 멱등 탭에서 구성된 ID 공급자의 IdP ID 행에 있는 정보 아이콘을 클릭하여 찾을 수 있습니다. 다른 모든 버전에서는 24자리 16진수 ID를 사용합니다. |
-o, --output | 문자열 | 거짓 | 기본 설정 API 형식은 ["JSON", go- Template] 일 수 있습니다. 이 값의 기본값은 "JSON" 입니다. |
--outputFile | 문자열 | 거짓 | API 출력을 쓰기 (write) 파일 입니다. 이 플래그는 엔드포인트의 출력이 바이너리(예: gzip)이고 명령이 파이프되지 않은 경우(예: Atlas 명령 > out.zip)에 필요합니다. |
--version | 문자열 | 거짓 | API 호출 시 사용할 API 버전 [옵션: "2023-11-15"], 기본값은 최신 버전 또는 프로필 api_version 구성 값( 설정하다 경우) 이 값 기본값은 '2023-11-15". |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요. |