Atlas 조직 초대 초대

지정된 MongoDB 사용자를 조직에 초대합니다.

공개 미리 보기: MongoDB Atlas 관리자 API 에서 자동으로 생성된 Atlas API 하위 명령은 관리자 API 에 대한 전체 범위를 제공하며 현재 공개 미리 보기로 제공됩니다( 피드백 https:// 피드백.mongodb.com/에서 제공하세요. 포럼/930808-Atlas-cli). 관리자 API 기능에는 자체 출시하다 수명 주기가 있으며, 이는 제공된 API 엔드포인트 문서 링크를 통해 확인할 수 있습니다.

이 명령을 사용하려면 조직 사용자 관리자 역할이 있는 사용자 계정 또는 API 키로 인증해야 합니다.

구문

명령 구문

atlas organizations invitations invite <email> [options]

arguments

이름	유형	필수 사항	설명
이메일	문자열	true	조직에 초대하려는 사용자의 이메일 주소입니다.

옵션

이름	유형	필수 사항	설명
-f, --file	문자열	거짓	초대 설정을 정의하는 선택적 JSON 구성 파일 의 경로입니다. 참고: JSON 파일 에서 지원되지 않는 필드는 무시됩니다. -- 역할, --teamId 와 상호 배타적입니다.
-h, --help		거짓	초대 도움말
--orgId	문자열	거짓	사용할 조직 ID입니다. 이 옵션은 구성 파일 또는 환경 변수의 설정을 재정의합니다.
-o, --output	문자열	거짓	출력 형식입니다. 유효한 값은 json, json-path, go-템플릿 또는 go-템플릿 파일입니다. 전체 출력을 보려면 -o json 옵션을 사용합니다.
--role	strings	거짓	연결된 조직에 대한 사용자의 역할입니다. 유효한 값은 ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_READ_ONLY입니다. --file과 상호 배타적입니다.
--teamId	strings	거짓	팀을 식별하는 고유한 24자리 문자열입니다. --file과 상호 배타적입니다.

상속된 옵션

이름	유형	필수 사항	설명
-P, --profile	문자열	거짓	구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요.

출력

명령이 성공하면 Atlas CLI는 다음 샘플과 유사한 출력을 반환합니다. 괄호 안의 값은 사용자의 값을 나타냅니다.

User '<Username>' invited.

예시

# Invite the MongoDB user with the email user@example.com to the organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access:
atlas organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json

돌아가기

설명