Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas api databaseUsers updateDatabaseUser

๊ณต๊ฐœ ๋ฏธ๋ฆฌ ๋ณด๊ธฐ: ํ”ผ๋“œ๋ฐฑ ์ œ๊ณตํ•˜์„ธ์š”: ์ง€์ •๋œ ํ”„๋กœ์ ํŠธ ์— ์†ํ•œ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ์‚ฌ์šฉ์ž ํ•œ ๋ช…์„ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค.

๊ณต๊ฐœ ๋ฏธ๋ฆฌ ๋ณด๊ธฐ: MongoDB Atlas ๊ด€๋ฆฌ์ž API ์—์„œ ์ž๋™์œผ๋กœ ์ƒ์„ฑ๋œ Atlas API ํ•˜์œ„ ๋ช…๋ น์€ ๊ด€๋ฆฌ์ž API ์— ๋Œ€ํ•œ ์ „์ฒด ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•˜๋ฉฐ ํ˜„์žฌ ๊ณต๊ฐœ ๋ฏธ๋ฆฌ ๋ณด๊ธฐ๋กœ ์ œ๊ณต๋ฉ๋‹ˆ๋‹ค( ํ”ผ๋“œ๋ฐฑ https://feedback.mongodb.com/forums/930808-Atlas-cli). ๊ด€๋ฆฌ์ž API ๊ธฐ๋Šฅ์—๋Š” ์ž์ฒด ์ถœ์‹œํ•˜๋‹ค ์ˆ˜๋ช… ์ฃผ๊ธฐ๊ฐ€ ์žˆ์œผ๋ฉฐ, ์ด๋Š” ์ œ๊ณต๋œ API ์—”๋“œํฌ์ธํŠธ ๋ฌธ์„œ ๋งํฌ๋ฅผ ํ†ตํ•ด ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์ด ๋ฆฌ์†Œ์Šค๋ฅผ ์‚ฌ์šฉํ•˜๋ ค๋ฉด, ์š”์ฒญํ•˜๋Š” ์„œ๋น„์Šค ๊ณ„์ • ๋˜๋Š” API ํ‚ค์— ํ”„๋กœ์ ํŠธ ์†Œ์œ ์ž ์—ญํ• , ํ”„๋กœ์ ํŠธ ์ฐจํŠธ ๊ด€๋ฆฌ์ž ์—ญํ• , ํ”„๋กœ์ ํŠธ ์ŠคํŠธ๋ฆผ ์ฒ˜๋ฆฌ ์†Œ์œ ์ž ์—ญํ•  ๋˜๋Š” ํ”„๋กœ์ ํŠธ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ์•ก์„ธ์Šค ๊ด€๋ฆฌ์ž ์—ญํ• ์ด ์žˆ์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

์ด ๋ช…๋ น์€ ์ž๋™์œผ๋กœ ์ƒ์„ฑ๋˜๋ฉฐ 1 1 Atlas API ์—”๋“œํฌ์ธํŠธ https://www.mongodb.com/ko-kr/docs/atlas/reference/api-resources-spec/v2/# ํƒœ๊ทธ๋ฅผ ์ง€์ •ํ•˜๋‹ค/Database- Users/operation/updateDatabaseUser.

์ž์„ธํ•œ ๋‚ด์šฉ๊ณผ ์˜ˆ์‹œ๋Š” ์œ„์— ๋งํฌ๋œ ์ฐธ์กฐ API ๋ฌธ์„œ๋ฅผ ์ฐธ์กฐํ•˜์„ธ์š”.

๋ช…๋ น ๊ตฌ๋ฌธ
atlas api databaseUsers updateDatabaseUser [options]
์ด๋ฆ„
์œ ํ˜•
ํ•„์ˆ˜ ์‚ฌํ•ญ
์„ค๋ช…

--databaseName

$external

true

๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ์‚ฌ์šฉ์ž๊ฐ€ ์ธ์ฆํ•˜๋Š” ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ์ž…๋‹ˆ๋‹ค. ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ์‚ฌ์šฉ์ž๋Š” ์‚ฌ์šฉ์ž ์ด๋ฆ„ ๊ณผ ์ธ์ฆ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ๋ชจ๋‘ ์ œ๊ณตํ•ด์•ผ MongoDB ์— ๋กœ๊ทธ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์‚ฌ์šฉ์ž๊ฐ€ Amazon Web Services IAM, x.509, LDAP ๋˜๋Š” OIDC ์›Œํฌ๋กœ๋“œ๋กœ ์ธ์ฆํ•˜๋Š” ๊ฒฝ์šฐ ์ด ๊ฐ’์€ $external์ด์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ์‚ฌ์šฉ์ž๊ฐ€ SCRAM-SHA ๋˜๋Š” OIDC Workforce๋กœ ์ธ์ฆํ•˜๋Š” ๊ฒฝ์šฐ ์ด ๊ฐ’์€ admin์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค.

--envelope

envelope

๊ฑฐ์ง“

์• ํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ์‘๋‹ต์„ ์—”๋ฒจ๋กœํ”„ JSON ๊ฐ์ฒด ๋กœ ๋ž˜ํ•‘ํ• ์ง€ ์—ฌ๋ถ€๋ฅผ ๋‚˜ํƒ€๋‚ด๋Š” ํ”Œ๋ž˜๊ทธ์ž…๋‹ˆ๋‹ค. ์ผ๋ถ€ API ํด๋ผ์ด์–ธํŠธ๋Š” HTTP ์‘๋‹ต ํ—ค๋” ๋˜๋Š” ์ƒํƒœ ์ฝ”๋“œ์— ์•ก์„ธ์Šค ํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค. ์ด ๋ฌธ์ œ๋ฅผ ํ•ด๊ฒฐํ•˜๋ ค๋ฉด ์ฟผ๋ฆฌ ์—์„œ envelope=true ๋ฅผ ์„ค์ •ํ•˜๋‹ค . ๊ฒฐ๊ณผ ๋ชฉ๋ก์„ ๋ฐ˜ํ™˜ํ•˜๋Š” ์—”๋“œํฌ์ธํŠธ๋Š” ๊ฒฐ๊ณผ ๊ฐ์ฒด ์—”๋ฒจ๋กœํ”„๋กœ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜์€ ์‘๋‹ต ๋ณธ๋ฌธ์— ์ƒํƒœ ๋งค๊ฐœ๋ณ€์ˆ˜๋ฅผ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.

--file

๋ฌธ์ž์—ด

๊ฑฐ์ง“

API ์š”์ฒญ ํŒŒ์ผ ์˜ ๊ฒฝ๋กœ์ž…๋‹ˆ๋‹ค. ํ‘œ์ค€ ์ž…๋ ฅ์„ ๋Œ€์‹  ์‚ฌ์šฉํ•˜๋ ค๋ฉด ๋น„์›Œ ๋‘์„ธ์š” - ๋‘˜ ์ค‘ ํ•˜๋‚˜๋ฅผ ์ œ๊ณตํ•ด์•ผ ํ•˜์ง€๋งŒ ๋‘˜ ๋‹ค ์ œ๊ณตํ•  ์ˆ˜๋Š” ์—†์Šต๋‹ˆ๋‹ค.

--groupId

๋ฌธ์ž์—ด

true

ํ”„๋กœ์ ํŠธ ์‹๋ณ„ํ•˜๋Š” ๊ณ ์œ ํ•œ 24-16์ง„์ˆ˜ ๋ฌธ์ž์—ด์ž…๋‹ˆ๋‹ค. [/groups](# ํƒœ๊ทธ๋ฅผ ์ง€์ •ํ•˜๋‹ค /Projects/operation/listProjects) ์—”๋“œํฌ์ธํŠธ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์ธ์ฆ๋œ ์‚ฌ์šฉ์ž๊ฐ€ ์•ก์„ธ์Šค ํ•  ์ˆ˜ ์žˆ๋Š” ๋ชจ๋“  ํ”„๋กœ์ ํŠธ๋ฅผ ์กฐํšŒ .

์ฐธ๊ณ : ๊ทธ๋ฃน๊ณผ ํ”„๋กœ์ ํŠธ๋Š” ๋™์˜์–ด์ž…๋‹ˆ๋‹ค. ๊ทธ๋ฃน ID๋Š” ํ”„๋กœ์ ํŠธ ID์™€ ๋™์ผํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ์กด ๊ทธ๋ฃน์˜ ๊ฒฝ์šฐ, ๊ทธ๋ฃน/ํ”„๋กœ์ ํŠธ ID๋Š” ๋™์ผํ•˜๊ฒŒ ์œ ์ง€๋ฉ๋‹ˆ๋‹ค. ๋ฆฌ์†Œ์Šค ๋ฐ ํ•ด๋‹น ์—”๋“œํฌ์ธํŠธ๋Š” ๊ทธ๋ฃน์ด๋ผ๋Š” ์šฉ์–ด๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.

-h, --help

๊ฑฐ์ง“

updateDatabaseUser์— ๋Œ€ํ•œ ๋„์›€๋ง

-o, --output

๋ฌธ์ž์—ด

๊ฑฐ์ง“

๊ธฐ๋ณธ ์„ค์ • API ํ˜•์‹์€ ["JSON", go- Template] ์ผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ด ๊ฐ’์˜ ๊ธฐ๋ณธ๊ฐ’์€ "JSON" ์ž…๋‹ˆ๋‹ค.

--outputFile

๋ฌธ์ž์—ด

๊ฑฐ์ง“

API ์ถœ๋ ฅ์„ ์“ฐ๊ธฐ (write) ํŒŒ์ผ ์ž…๋‹ˆ๋‹ค. ์ด ํ”Œ๋ž˜๊ทธ๋Š” ์—”๋“œํฌ์ธํŠธ์˜ ์ถœ๋ ฅ์ด ๋ฐ”์ด๋„ˆ๋ฆฌ(์˜ˆ: gzip)์ด๊ณ  ๋ช…๋ น์ด ํŒŒ์ดํ”„๋˜์ง€ ์•Š์€ ๊ฒฝ์šฐ(์˜ˆ: Atlas ๋ช…๋ น > out.zip)์— ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.

--pretty

๊ฑฐ์ง“

์‘๋‹ต ๋ณธ๋ฌธ์ด ํ”„๋ฆฌํ‹ฐํ”„๋ฆฐํŠธ ํ˜•์‹์ด์–ด์•ผ ํ•˜๋Š”์ง€ ์—ฌ๋ถ€๋ฅผ ๋‚˜ํƒ€๋‚ด๋Š” ํ”Œ๋ž˜๊ทธ์ž…๋‹ˆ๋‹ค.

--username

๋ฌธ์ž์—ด

true

MongoDB์— ์ธ์ฆํ•˜๋Š” ์‚ฌ์šฉ์ž๋ฅผ ๋‚˜ํƒ€๋‚ด๋Š” ์ธ๊ฐ„ ํŒ๋… ๊ฐ€๋Šฅ ๋ ˆ์ด๋ธ”. ์ด ๋ ˆ์ด๋ธ”์˜ ํ˜•์‹์€ ์ธ์ฆ ๋ฐฉ๋ฒ•์— ๋”ฐ๋ผ ๋‹ค๋ฆ…๋‹ˆ๋‹ค.

Authentication Method | Parameter Needed | Parameter Value | username Format |
AWS IAM | awsIAMType | ROLE | <abbr title="Amazon Resource Name">ARN</abbr> |
AWS IAM | awsIAMType | USER | <abbr title="Amazon Resource Name">ARN</abbr> |
x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |
OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |
SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |

--version

๋ฌธ์ž์—ด

๊ฑฐ์ง“

API ํ˜ธ์ถœ ์‹œ ์‚ฌ์šฉํ•  API ๋ฒ„์ „ [์˜ต์…˜: "2023-01-01"], ๊ธฐ๋ณธ๊ฐ’์€ ์ตœ์‹  ๋ฒ„์ „ ๋˜๋Š” ํ”„๋กœํ•„ api_version ๊ตฌ์„ฑ ๊ฐ’( ์„ค์ •ํ•˜๋‹ค ๊ฒฝ์šฐ) ์ด ๊ฐ’ ๊ธฐ๋ณธ๊ฐ’์€ '2023-01-01".

์ด๋ฆ„
์œ ํ˜•
ํ•„์ˆ˜ ์‚ฌํ•ญ
์„ค๋ช…

-P, --profile

๋ฌธ์ž์—ด

๊ฑฐ์ง“

๊ตฌ์„ฑ ํŒŒ์ผ ์—์„œ ์‚ฌ์šฉํ•  ํ”„๋กœํ•„์˜ ์ด๋ฆ„์ž…๋‹ˆ๋‹ค. Atlas CLI ์˜ ํ”„๋กœํ•„์— ๋Œ€ํ•ด ํ•™์Šต https://dochub.mongodb.org/core/atlas-cli-save-connection-settings๋ฅผ ์ฐธ์กฐํ•˜์„ธ์š”.

๋Œ์•„๊ฐ€๊ธฐ

listDatabaseUsers

์ด ํŽ˜์ด์ง€์˜ ๋‚ด์šฉ