Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

Atlas 조직 apiKeys 설명

이 페이지의 내용

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

조직에 지정된 API 키에 대한 세부 정보를 반환합니다.

ID 인수에 사용할 수 있는 값을 보려면 atlas 조직 apiKeys 목록을 실행합니다.

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

명령 구문
atlas organizations apiKeys describe <ID> [options]
이름
유형
필수 사항
설명
ID
문자열
true
API 키를 식별하는 고유한 24자리 문자열입니다.
이름
유형
필수 사항
설명
-h, --help
거짓
설명 도움말
--orgId
문자열
거짓
사용할 조직 ID입니다. 이 옵션은 구성 파일 또는 환경 변수의 설정을 재정의합니다.
-o, --output
문자열
거짓
출력 형식입니다. 유효한 값은 json, json-path, go-템플릿 또는 go-템플릿 파일입니다. 전체 출력을 보려면 -o json 옵션을 사용합니다.
이름
유형
필수 사항
설명
-P, --profile
문자열
거짓
구성 파일에서 사용할 프로필의 이름입니다. Atlas CLI의 프로필에 대해 자세히 알아보려면 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요.

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

ID DESCRIPTION PUBLIC KEY PRIVATE KEY
<Id> <Desc> <PublicKey> <PrivateKey>
# Return the JSON-formatted details for the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345:
atlas organizations apiKeys describe 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 -output json

돌아가기

삭제