Criar uma política de recursos do Atlas

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

Contas de serviço DigestAuth

Crie uma Política de Recursos do Atlas para uma organização.

Políticas de recursos do Atlas

parâmetros de caminho

orgId string Obrigatório

24String exclusiva de dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para recuperar todas as organizações às quais o usuário autenticado tem acesso.

O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

parâmetros de query

envelope booleano

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

O valor padrão é false.
pretty booleano

Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

O valor padrão é false.

Prettyprint

application/vnd.atlas.2024-08-05+json

corpo, corpo Obrigatório

Política de recursos do Atlas a ser criada.

Descrição string

Descrição da política de recursos do Atlas.
name string Obrigatório

Etiqueta legível por humanos que descreve a política de recursos do Atlas.
políticas array[objeto] Obrigatório

Lista de políticas que compõem a política de recursos do atlas.
Ocultar atributo de políticas Mostrar atributo das políticas objeto
- corpo, corpo string Obrigatório
  
  Uma string que define as permissões para a política. A sintaxe utilizada é a linguagem da Política da Cedar.
  
  O comprimento mínimo é 1.

Respostas

201 application/vnd.atlas.2024-08-05+json

Criado
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- createdByUser objeto
  
  O usuário que atualizou pela última vez a política de recursos do Atlas.
  
  Ocultar atributos createdByUser Mostrar atributos createdByUser objeto
  
  id string
  
  String única de 24caracteres hexadecimais que identifica um usuário.
  
  O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
  
  name string
  
  Rótulo legível por humanos que descreve um usuário.
- createdDate string(data-hora)
  
  Data e hora em UTC em que a política de recursos do Atlas foi criada.
- Descrição string
  
  Descrição da política de recursos do Atlas.
- id string
  
  String exclusiva de 24caracteres hexadecimais que identifica a política de recursos do Atlas.
  
  O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
- lastUpdatedByUser objeto
  
  O usuário que atualizou pela última vez a política de recursos do Atlas.
  
  Ocultar atributos lastUpdatedByUser Mostrar atributos lastUpdatedByUser objeto
  
  id string
  
  String única de 24caracteres hexadecimais que identifica um usuário.
  
  O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
  
  name string
  
  Rótulo legível por humanos que descreve um usuário.
- lastUpdatedDate string(data-hora)
  
  Data e hora em UTC quando a política de recursos do Atlas foi atualizada pela última vez.
- name string
  
  Etiqueta legível por humanos que descreve a política de recursos do Atlas.
- orgId string
  
  String exclusiva de 24caracteres hexadecimais que identifica a organização à qual a política de recursos do Atlas pertence.
  
  O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
- políticas array[objeto]
  
  Lista de políticas que compõem a política de recursos do atlas.
  
  Ocultar atributos das políticas Mostrar atributos das políticas objeto
  
  corpo, corpo string
  
  Uma string que define as permissões para a política. A sintaxe utilizada é a linguagem da Política da Cedar.
  
  id string
  
  String única de 24caracteres hexadecimais que identifica a política.
  
  O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
- Versão string
  
  Uma string que identifica a versão da política de recursos do Atlas.
400 application/vnd.atlas.2024-08-05+json

Solicitação inválida.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- errorType string
  
  Etiqueta legível por humanos que exibe o tipo de erro.
  
  Os valores são POLICY_PARSING_ERROR, POLICY_HAS_FAILED_VALIDATIONS, POLICY_HAS_INVALID_PRINCIPAL, POLICY_HAS_BODY_EXCEEDING_MAX_SIZE ou POLICY_HAS_UNEXPECTED_ENTITIES.
- Políticas inválidas array[objeto]
  
  Lista de políticas inválidas contendo detalhes de seus erros de validação.
  
  Ocultar atributos invalidPolicies Mostrar atributos invalidPolicies objeto
  
  corpo, corpo string
  
  Uma string que define as permissões para a política. A sintaxe utilizada é a linguagem da Política da Cedar.
  
  errors array[objeto]
  
  Lista de erros de validação.
  
  Ocultar atributo de erros Mostrar atributo de erros objeto
  
  detalhe string
  
  Uma string que fornece uma descrição detalhada de um erro de validação.
401 aplicação/json

Não autorizado.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe string
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão string
  
  Mensagens de erro de aplicativo retornadas com este erro.
403 aplicação/json

Forbidden.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe string
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão string
  
  Mensagens de erro de aplicativo retornadas com este erro.
404 aplicação/json

Não encontrado.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe string
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão string
  
  Mensagens de erro de aplicativo retornadas com este erro.
500 aplicação/json

Erro interno do servidor.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe string
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão string
  
  Mensagens de erro de aplicativo retornadas com este erro.

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

atlas api resourcePolicies createOrgResourcePolicy --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241023001/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.CreateOrgResourcePolicyApiParams{}
	sdkResp, httpResp, err := client.ResourcePoliciesApi.
		CreateOrgResourcePolicyWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies" \
  -d '{ <Payload> }'

Exemplos de solicitação

{
  "description": "string",
  "name": "string",
  "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"
    }
  ]
}

Exemplos de resposta (201)

{
  "createdByUser": {
    "id": "32b6e34b3d91647abb20e7b8",
    "name": "string"
  },
  "createdDate": "2025-05-04T09:42:00Z",
  "description": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastUpdatedByUser": {
    "id": "32b6e34b3d91647abb20e7b8",
    "name": "string"
  },
  "lastUpdatedDate": "2025-05-04T09:42:00Z",
  "name": "string",
  "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"
}

Exemplos de resposta (400)

{
  "errorType": "POLICY_PARSING_ERROR",
  "invalidPolicies": [
    {
      "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",
      "errors": [
        {
          "detail": "string"
        }
      ]
    }
  ]
}

Exemplos de resposta (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Exemplos de resposta (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Exemplos de resposta (404)

{
  "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"
}

Exemplos de resposta (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}