mongocli iam globalApiKeys 업데이트
글로벌 API 키에 대한 역할 및 설명을 수정합니다.
구문
명령 구문
mongocli iam globalApiKeys update <ID> [options]
arguments
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
ID | 문자열 | true | 글로벌 API 키를 식별하는 고유한 24자리 문자열입니다. |
옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
--desc | 문자열 | true | API 키에 대한 설명입니다. |
-h, --help | 거짓 | 업데이트 도움말 | |
-o, --output | 문자열 | 거짓 | 출력 형식입니다. 유효한 값은 json, json-path, go-템플릿 또는 go-템플릿 파일입니다. 전체 출력을 보려면 -o json 옵션을 사용합니다. |
--role | strings | true | API 키에 할당하려는 역할입니다. 둘 이상의 역할을 할당하려면 별도의 역할 플래그로 각 역할을 지정하거나 하나의 역할 플래그를 사용하여 모든 역할을 쉼표로 구분된 목록으로 지정할 수 있습니다. 유효한 값은 GLOBAL_AUTOMATION_ADMIN, GLOBAL_BACKUP_ADMIN GLOBAL_MONITORING_ADMIN, GLOBAL_OWNER, GLOBAL_READ_ONLY, GLOBAL_USER_ADMIN입니다. 이 플래그를 전달하면 기존 데이터가 대체됩니다. |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일에서 사용할 프로필의 이름입니다. MongoCLI의 프로필에 대해 자세히 알아보려면 https://dochub.mongodb.org/core/atlas-cli-configuration-file을 참조하세요. |
예시
# Modify the roles and description for the global API key with the ID 5f5bad7a57aef32b04ed0210: mongocli iam globalApiKeys update 5f5bad7a57aef32b04ed0210 --desc "My Sample Global API Key" --role GLOBAL_MONITORING_ADMIN --output json