공개 미리 보기: 다음에서 피드백 제공하세요. 지정된 연합에서 ID 제공자 한 명을 삭제합니다.
이 리소스를 사용하려면 요청 API 키에 연결된 조직 중 하나의 조직 소유자 역할이 있어야 합니다.
참고: 멱등에 연결된 조직이 있으면 이 리소스에 대한 요청이 실패합니다. 멱등을 삭제하기 전에 모든 조직의 연결을 끊고 계정의 어떤 조직도 이 멱등을 사용하지 않는지 확인합니다. 자세한 내용은 연합 인증을 위한 조직 매핑 관리를 참조하세요.
이 명령은 자동으로 1 생성되며,1 Atlas API 엔드포인트 https://www.mongodb.com/ko-kr/docs/atlas/reference/api-resources-spec/v2/# 태그를 지정하다/Federated- 를 사용하여: 에 해당합니다. Authentication/operation/deleteIdentityProvider.
자세한 내용과 예시는 위에 링크된 참조 API 문서를 참조하세요.
구문
atlas api federatedAuthentication deleteIdentityProvider [options]
옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
--envelope | envelope | 거짓 | 애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다. |
--federationSettingsId | 문자열 | true | 연합을 식별하는 고유한 24자리 16진수 문자열. |
-h, --help | 거짓 | deleteIdentityProvider에 대한 도움말 | |
--identityProviderId | 문자열 | true | 연결할 멱등을 식별하는 고유한 24자리 16진수 문자열입니다. |
--출력 | 문자열 | 거짓 | 기본 설정 API 형식은 ["JSON", go- Template] 일 수 있습니다. 이 값의 기본값은 "JSON" 입니다. |
--출력 파일 | 문자열 | 거짓 | 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를 참조하세요. |
예시
아래 명령을 실행합니다.
atlas api federatedAuthentication deleteIdentityProvider --version 2023-11-15 --envelope false --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8