Atlas 리소스 정책 하나 검증

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

조직의 Atlas 리소스 정책 한 개에 대한 유효성 검사를 수행합니다.

Atlas 리소스 정책

경로 매개변수

  • orgId 문자열 필수 사항

    24프로젝트가 포함된 조직 식별하는 고유한 -16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 조직을 조회 하려면 /orgs 엔드포인트를 사용합니다.

    형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

쿼리 매개변수

  • envelope 부울

    애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

    기본값은 false 입니다.

  • pretty 부울

    응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

    기본값은 false 입니다.

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

body 필수 사항

생성할 Atlas 리소스 정책입니다.

  • description 문자열

    Atlas 리소스 정책 설명.

  • 이름 문자열 필수 사항

    사람이 읽을 수 있는 레이블로, Atlas 리소스 정책을 설명합니다.

  • 정책 배열[객체] 필수 사항

    Atlas 리소스 정책을 구성하는 정책 목록입니다.

    정책 속성 숨기기 정책 속성 표시 객체
    • body 문자열 필수 사항

      정책에 대한 권한을 정의하는 문자열입니다. 사용된 구문은 Cedar Policy 언어 입니다.

      최소 길이는 1입니다.

응답

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

    확인

    응답 속성 숨기기 응답 속성 표시 객체
    • createdByUser 객체

      Atlas 리소스 정책을 마지막으로 업데이트한 사용자입니다.

      createdByUser 속성 숨기기 createdByUser 속성 표시 객체
      • id 문자열

        고유한 24-사용자를 식별하는 16진수 문자열입니다.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • 이름 문자열

        사용자를 설명하는 사람이 읽을 수 있는 레이블입니다.

    • createdDate 문자열(날짜-시간)

      Atlas 리소스 정책이 생성된 날짜 및 시간(UTC)입니다.

    • description 문자열

      Atlas 리소스 정책 설명.

    • id 문자열

      Atlas 리소스 정책을 식별하는 고유한 24-16진수 문자열입니다.

      형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

    • lastUpdatedByUser 객체

      Atlas 리소스 정책을 마지막으로 업데이트한 사용자입니다.

      lastUpdatedByUser 속성 숨기기 lastUpdatedByUser 속성 표시 객체
      • id 문자열

        고유한 24-사용자를 식별하는 16진수 문자열입니다.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • 이름 문자열

        사용자를 설명하는 사람이 읽을 수 있는 레이블입니다.

    • lastUpdatedDate 문자열(날짜-시간)

      Atlas 리소스 정책이 마지막으로 업데이트된 날짜 및 시간(UTC 기준)입니다.

    • 이름 문자열

      사람이 읽을 수 있는 레이블로, Atlas 리소스 정책을 설명합니다.

    • orgId 문자열

      고유한 24-Atlas 리소스 정책이 속한 조직 식별하는 16진수 문자열입니다.

      형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

    • 정책 배열[객체]

      Atlas 리소스 정책을 구성하는 정책 목록입니다.

      정책 속성 숨기기 정책 속성 표시 객체
      • body 문자열

        정책에 대한 권한을 정의하는 문자열입니다. 사용된 구문은 Cedar Policy 언어 입니다.

      • id 문자열

        정책을 식별하는 고유한 24-16진수 문자열입니다.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

    • 버전 문자열

      Atlas 리소스 정책의 버전을 식별하는 문자열입니다.

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

    잘못된 요청입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • errorType 문자열

      오류 유형을 표시하는 사람이 읽을 수 있는 레이블입니다.

      값은 POLICY_PARSING_ERROR, POLICY_HAS_FAILED_VALIDATIONS, POLICY_HAS_INVALID_PRINCIPAL, POLICY_HAS_BODY_EXCEEDING_MAX_SIZE 또는 POLICY_HAS_UNEXPECTED_ENTITIES입니다.

    • invalidPolicies 배열[객체]

      유효성 검사 오류에 대한 세부 정보가 포함된 잘못된 정책 목록입니다.

      invalidPolicies 속성 숨기기 invalidPolicies 속성 표시 객체
      • body 문자열

        정책에 대한 권한을 정의하는 문자열입니다. 사용된 구문은 Cedar Policy 언어 입니다.

      • errors 배열[객체]

        유효성 검사 오류 목록입니다.

        오류 속성 숨기기 오류 속성 표시 객체
        • 세부 정보 문자열

          유효성 검사 검사 오류에 대한 자세한 설명을 제공하는 문자열입니다.

  • 401 application/json

    승인되지 않았습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 403 application/json

    Forbidden.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 404 application/json

    찾을 수 없습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 500 application/json

    내부 서버 오류입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

POST /api/atlas/v2/orgs/{orgId}/resourcePolicies:validate
atlas api resourcePolicies validateOrgResourcePolicies --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250219001/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.ValidateOrgResourcePoliciesApiParams{}
	sdkResp, httpResp, err := client.ResourcePoliciesApi.
		ValidateOrgResourcePoliciesWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate" \
  -d '{ <Payload> }'
요청 예시
{
  "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"
    }
  ]
}
응답 예시(200)
{
  "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"
}
응답 예시(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"
        }
      ]
    }
  ]
}
응답 예시(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"
}
응답 예시(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"
}
응답 예시(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"
}
응답 예시(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"
}