MOmongodb
Resource Policies

Create One Atlas Resource Policy

Create one Atlas Resource Policy for an organization.

post/api/atlas/v2/orgs/{orgId}/resourcePolicies

Request

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

descriptionstring nullable

Description of the atlas resource policy.

namestring required

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

Created

createdDatestring date-time

Date and time in UTC when the atlas resource policy was created.

descriptionstring

Description of the atlas resource policy.

idstring

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

lastUpdatedDatestring date-time

Date and time in UTC when the atlas resource policy was last updated.

namestring

Human-readable label that describes the atlas resource policy.

orgIdstring

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

versionstring

A string that identifies the version of the atlas resource policy.

Example response

{
  "createdByUser": {
    "id": "32b6e34b3d91647abb20e7b8"
  },
  "id": "32b6e34b3d91647abb20e7b8",
  "lastUpdatedByUser": {
    "id": "32b6e34b3d91647abb20e7b8"
  },
  "orgId": "32b6e34b3d91647abb20e7b8",
  "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",
      "id": "32b6e34b3d91647abb20e7b8"
    }
  ],
  "version": "v1"
}

Changes

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