조직 API 키를 생성하여 프로젝트에 할당합니다.
공개 미리 보기: MongoDB Atlas 관리자 API 에서 자동으로 생성된 Atlas API 하위 명령은 관리자 API 에 대한 전체 범위를 제공하며 현재 공개 미리 보기로 제공됩니다( 피드백 https:// 피드백.mongodb.com/에서 제공하세요. 포럼/930808-Atlas-cli). 관리자 API 기능에는 자체 출시하다 수명 주기가 있으며, 이는 제공된 API 엔드포인트 문서 링크를 통해 확인할 수 있습니다.
MongoDB 비공개 API 키 한 번만 반환합니다. 이 명령을 실행 후 즉시 공개 및 비공개 API 키를 복사하여 저장하고 보호합니다. 조직 수준 역할 제공하지 않으면 API 키는 기본적으로 프로젝트 상위 조직 의 조직 구성원으로 설정됩니다.
이 명령을 사용하려면 프로젝트 사용자 관리자 또는 조직 사용자 관리자 역할 중 하나를 가진 사용자 계정 또는 API 키로 인증해야 조직 수준의 역할을 관리 할 수 있습니다.
구문
atlas projects apiKeys create [options]
옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
--desc | 문자열 | true | API 키에 대한 설명입니다. |
-h, --help | 거짓 | 만들기 도움말 | |
-o, --output | 문자열 | 거짓 | 출력 형식입니다. 유효한 값은 json, json-path, go-템플릿 또는 go-템플릿 파일입니다. 전체 출력을 보려면 -o json 옵션을 사용합니다. |
--projectId | 문자열 | 거짓 | 사용할 프로젝트를 식별하는 16진수 문자열입니다. 이 옵션은 구성 파일 또는 환경 변수의 설정을 재정의합니다. |
--role | strings | true | API 키에 할당하려는 하나 이상의 역할입니다. 둘 이상의 역할 할당하려면 별도의 역할 플래그로 각 역할 지정하거나 하나 역할 플래그를 사용하여 모든 역할을 쉼표로 구분된 목록으로 지정합니다. 허용되는 값의 전체 목록은 해당 Atlas API 엔드포인트에 대한 ItemsEnum(https://www.mongodb.com/ko-kr/docs/atlas/reference/api-resources-spec/v2/ # 태그를 지정하다/Programmatic)을 참조하세요. - API-Keys/operation/createProjectApiKey . 프로젝트 수준 사용자 역할에 대해 자세히 학습하려면 https://dochub.mongodb.org/core/atlas-proj-roles를 참조하세요. |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일에서 사용할 프로필의 이름입니다. Atlas CLI의 프로필에 대해 자세히 알아보려면 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요. |
출력
명령이 성공하면 Atlas CLI는 다음 샘플과 유사한 출력을 반환합니다. 괄호 안의 값은 사용자의 값을 나타냅니다.
API Key '<Id>' created. Public API Key <PublicKey> Private API Key <PrivateKey>
예시
# Create an organization API key with the GROUP_OWNER role and assign it to the project with ID 5e2211c17a3e5a48f5497de3: atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_OWNER --output json
# Create an organization API key with the GROUP_SEARCH_INDEX_EDITOR and GROUP_DATABASE_ACCESS_ADMIN roles and assign it to the project with ID 5e2211c17a3e5a48f5497de3: atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_SEARCH_INDEX_EDITOR,GROUP_DATABASE_ACCESS_ADMIN --output json