MOmongodb
Organizations

Update Settings for One Organization

Updates the organization's settings.

patch/api/atlas/v2/orgs/{orgId}/settings

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

orgIdstring required
Example:4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Request body

apiAccessListRequiredboolean

Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.

genAIFeaturesEnabledboolean

Flag that indicates whether this organization has access to generative AI features. This setting only applies to Atlas Commercial and is enabled by default. Once this setting is turned on, Project Owners may be able to enable or disable individual AI features at the project level.

maxServiceAccountSecretValidityInHoursinteger

Number that represents the maximum period before expiry in hours for new Atlas Admin API Service Account secrets within the specified organization.

multiFactorAuthRequiredboolean

Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/.

operationsContactstring nullable

String that specifies a distribution list email address for the specified organization to receive proactive notifications about its infrastructure. The operations contact is used for notifications only and is not authorized to make decisions or approvals. Passing an explicit null clears the existing operations contact (if any). An empty string is invalid and is rejected with a validation error.

restrictEmployeeAccessboolean

Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure and cluster logs for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/.

securityContactstring

String that specifies a single email address for the specified organization to receive security-related notifications. Specifying a security contact does not grant them authorization or access to Atlas for security decisions or approvals. An empty string is valid and clears the existing security contact (if any).

streamsCrossGroupEnabledboolean

Flag that indicates whether a group's Atlas Stream Processing workspaces in this organization can create connections to other group's clusters in the same organization.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.