1 つの組織の設定を更新
組織の設定を更新します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに組織オーナーのロールが必要です。
path パラメータ
-
24プロジェクトを含む組織を識別する一意の 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgs エンドポイントを使用します。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$
。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelope
JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
false
です。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
false
です。Prettyprint
body
必須
指定した組織の設定でアップデートする詳細。
-
API 操作に対し、指定された組織の API アクセスリストに追加された IP アドレスからの発信を要求するかどうかを示すフラグ。
-
この組織が生成系AI機能にアクセスしているかどうかを示すフラグ。 この設定は Atlas CMK にのみ適用され、デフォルトで有効になっています。 この設定をオンにすると、プロジェクトオーナーはプロジェクトレベルで個々のAI機能を有効または無効にできる可能性があります。
デフォルト値は
true
です。生成系 AI FAQ -
指定された組織内の新しい Atlas Admin APIサービス アカウント シークレットの有効期限が切れるまでの最大期間を時間単位で表す数値。
最小値は
8
、最大値は8760
です。 -
指定された組織にアクセスする前に、ユーザーに多要素認証(MFA)を設定することを要求するかどうかを示すフラグ。詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/security-multi-factor-authentication/ を参照してください。
-
MongoDBサポートが、指定された組織内の任意のデプロイで Atlas インフラストラクチャとクラスター ログに明示的な許可なしでアクセスするのをブロックするかどうかを示すフラグ。この設定をオンにすると、サポートの問題を解決するために、 MongoDBサポートに対して Atlas24 の配置への 時間のバイパス アクセスを許可することができます。詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/security-restrict-support-access/ を参照してください。
-
stringstring は、指定された組織の単一のメールアドレスを指定し、セキュリティ関連の通知を受信します。セキュリティ担当者を指定しても、セキュリティ上の決定や承認のために Atlas への認可やアクセスは許可されません。 string空の文字列は有効であり、既存のセキュリティ連絡先(存在する場合)をクリアします。
-
この組織内のグループの Atlas Stream Processing インスタンスが、同じ組織内の他のグループのクラスターへの接続を作成できるかどうかを示すフラグ。
atlas api organizations updateOrgSettings --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.UpdateOrgSettingsApiParams{}
sdkResp, httpResp, err := client.OrganizationsApi.
UpdateOrgSettingsWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \
-d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \
-d '{ <Payload> }'
{
"apiAccessListRequired": true,
"genAIFeaturesEnabled": true,
"maxServiceAccountSecretValidityInHours": 42,
"multiFactorAuthRequired": true,
"restrictEmployeeAccess": true,
"securityContact": "string",
"streamsCrossGroupEnabled": true
}
{
"apiAccessListRequired": true,
"genAIFeaturesEnabled": true,
"maxServiceAccountSecretValidityInHours": 42,
"multiFactorAuthRequired": true,
"restrictEmployeeAccess": true,
"securityContact": "string",
"streamsCrossGroupEnabled": true
}
{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
{
"error": 429,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Too Many Requests",
"errorCode": "RATE_LIMITED"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}