공개 미리 보기: 피드백 제공하세요: 지정된 조직 과 연결된 보류 중인 활성 MongoDB Cloud 사용자에 대한 세부 정보를 반환합니다.
공개 미리 보기: MongoDB Atlas 관리자 API 에서 자동으로 생성된 Atlas API 하위 명령은 관리자 API 에 대한 전체 기능을 제공하며 현재 공개 미리 보기로 제공됩니다( 피드백 https://feedback.mongodb.com/forums/930808-Atlas-cli). 관리자 API 기능에는 자체 출시하다 수명 주기가 있으며, 이는 제공된 API 엔드포인트 문서 링크를 통해 확인할 수 있습니다.
이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 조직 구성원 역할이 있어야 합니다.
참고: 이 리소스는 사용 중단된 한 MongoDB 클라우드 사용자를 한 프로젝트에 초대 엔드포인트를 통해 초대된 사용자에 대한 세부 정보를 보는 데 사용할 수 없습니다.
참고: 대기 중인 사용자와 활성 사용자를 모두 반환하려면 v2-{2025-02-19} 이상을 사용하세요. 사용 중단된 버전을 사용하는 경우 활성 사용자만 반환됩니다.
이 명령은 자동으로 생성되며 1 1 Atlas API 엔드포인트 https://www.mongodb.com/ko-kr/docs/atlas/reference/api-resources-spec/v2/# 태그를 지정하다/ MongoDB-: 에 해당합니다. Cloud-Users/operation/listOrganizationUsers.
자세한 내용과 예시는 위에 링크된 참조 API 문서를 참조하세요.
구문
atlas api mongoDbCloudUsers listOrganizationUsers [options]
옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
--envelope | envelope | 거짓 | 애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다. |
-h, --help | 거짓 | listOrganizationUsers 도움말 | |
--includeCount | 거짓 | 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다. | |
--itemsPerPage | int | 거짓 | 페이지당 응답이 반환하는 항목 수입니다. |
--orgId | 문자열 | true | 프로젝트가 포함된 조직 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 조직을 조회 하려면 [/orgs](# 태그를 지정하다 /Organizations/operation/listOrganizations) 엔드포인트를 사용하세요. |
--orgMembershipStatus | 문자열 | 거짓 | 사용자를 필터링하기 위한 조직 멤버십 상태입니다. 이 매개변수를 제외하면 리소스는 대기 중인 사용자와 활성 사용자를 모두 반환합니다. 사용 중단된 버전에서는 지원되지 않습니다. |
-o, --output | 문자열 | 거짓 | 기본 설정 API 형식은 ["JSON", go- Template] 일 수 있습니다. 이 값의 기본값은 "JSON" 입니다. |
--outputFile | 문자열 | 거짓 | API 출력을 쓰기 (write) 파일 입니다. 이 플래그는 엔드포인트의 출력이 바이너리(예: gzip)이고 명령이 파이프되지 않은 경우(예: Atlas 명령 > out.zip)에 필요합니다. |
--pageNum | int | 거짓 | 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다. |
--pretty | 거짓 | 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. | |
--username | 문자열 | 거짓 | 사용자를 필터링할 이메일 주소입니다. 사용 중단된 버전에서는 지원되지 않습니다. |
--version | 문자열 | 거짓 | API 호출 시 사용할 API 버전 [옵션: "2023-01-01", "2025-02-19"], 기본값은 최신 버전 또는 프로필 api_version 구성 값( 설정하다 경우) 이 값의 기본값은 '2025-02-19'입니다. |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요. |
예시
atlas api mongoDbCloudUsers listOrganizationUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE