MOmongodb
Resource Policies

Update One Atlas Resource Policy

Update one Atlas Resource Policy for an organization.

patch/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}
  • 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.

resourcePolicyIdstring required

Unique 24-hexadecimal character string that identifies the atlas resource policy.

Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies an atlas resource policy.

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

descriptionstring nullable

Description of the atlas resource policy.

namestring nullable

Human-readable label that describes the atlas resource policy.

Example request

{
  "policies": [
    {
      "body": "  forbid (\n    principal,\n    action == cloud::Action::\"cluster.createEdit\",\n    resource\n  ) when {\n   context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n  };\n"
    }
  ]
}

Response

Ok

Changes

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