Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

Atlas 조직 apiKeys 생성

이 페이지의 내용

  • 구문
  • 옵션
  • 상속된 옵션
  • 출력
  • 예시

조직을 위한 API 키를 생성합니다.

MongoDB는 비공개 API 키를 한 번만 반환합니다. 이 명령을 실행한 후 즉시 공개 및 비공개 API 키를 복사하여 저장하고 보호합니다.

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

명령 구문
atlas organizations apiKeys create [options]
이름
유형
필수 사항
설명
--desc
문자열
true
API 키에 대한 설명입니다.
-h, --help
거짓
만들기 도움말
--orgId
문자열
거짓
사용할 조직 ID입니다. 이 옵션은 구성 파일 또는 환경 변수의 설정을 재정의합니다.
-o, --output
문자열
거짓
출력 형식입니다. 유효한 값은 json, json-path, go-템플릿 또는 go-템플릿 파일입니다. 전체 출력을 보려면 -o json 옵션을 사용합니다.
--role
strings
true
API 키에 할당하려는 하나 이상의 역할입니다. 둘 이상의 역할 을 할당하려면 별도의 역할 플래그로 각 역할 을 지정하거나 하나의 역할 플래그를 사용하여 모든 역할을 쉼표로 구분된 목록으로 지정합니다. CLI 에서 허용하는 값을 학습 보려면 Atlas API 사양에서 역할에 대한 항목 열거형을 참조하세요: https://www.mongodb.com/ko-kr/docs/atlas/reference/api-resources-spec/v2/ # 태그를 지정하다/Programmatic- API-Keys/operation/createApiKey/.
이름
유형
필수 사항
설명
-P, --profile
문자열
거짓

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

API Key '<Id>' created.
Public API Key <PublicKey>
Private API Key <PrivateKey>
# Create an organization API key with organization owner access in the organization with the ID 5a1b39eec902201990f12345:
atlas organizations apiKeys create --role ORG_OWNER --desc "My API Key" --orgId 5a1b39eec902201990f12345 --output json

돌아가기

할당하다