1개의 프로젝트에서 LDAP 구성 검증 상태 반환

얻다 /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}

지정된 프로젝트에 대해 하나의 LDAP 구성을 확인하기 위한 하나의 요청 상태를 반환합니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

경로 매개변수

  • groupId 문자열 필수 사항

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

    참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

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

  • requestId 문자열 필수 사항

    LDAP(Lightweight Directory Access Protocol) 구성을 확인하는 요청을 식별하는 고유 문자열입니다.

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

쿼리 매개변수

  • envelope 부울

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

    기본값은 false 입니다.

  • pretty 부울

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

    기본값은 false 입니다.

    Prettyprint

응답

  • 200 application/vnd.atlas.2023-01-01+json

    확인

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

      TLS(전송 계층 보안) 구성을 통해 이 LDAP (Lightweight Directory Access Protocol)와 연결된 프로젝트 식별하는 고유한 24-16진수 문자열입니다.

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

    • 요청 객체

      TLS(전송 계층 보안) 구성을 통한 LDAP(Lightweight Directory Access Protocol)를 확인하는 데 필요한 정보를 요청합니다. 응답은 bindPassword를 반환하지 않습니다.

      요청 속성 숨기기 요청 속성 표시 객체
      • bindUsername 문자열 필수 사항

        MongoDB Cloud가 LDAP 호스트에 연결하는 데 사용하는 경량 디렉토리 액세스 프로토콜(LDAP) 사용자의 전체 고유 이름(DN)입니다. LDAP 고유 이름은 RFC 2253에 따라 서식을 지정해야 합니다.

        형식은 ^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$ 패턴 과 일치해야 합니다.

        RFC 2253
      • caCertificate 문자열

        MongoDB 클라우드가 경량 디렉토리 액세스 프로토콜(LDAP) 호스트의 신원을 확인하는 데 사용하는 인증 기관(CA) 인증서입니다. MongoDB Cloud는 자체 서명된 인증서를 허용합니다. 할당된 값을 삭제하려면 빈 문자열을 전달합니다: "caCertificate": "".

      • 호스트 이름 문자열 필수 사항

        경량 디렉토리 액세스 프로토콜(LDAP) 호스트의 호스트 이름 또는 인터넷 프로토콜(IP) 주소를 식별하는 사람이 읽을 수 있는 레이블입니다. 이 호스트는 인터넷에 액세스할 수 있거나 클러스터에 대한 가상 사설 클라우드 (VPC) 피어링 연결이 있어야 합니다.

        형식은 ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?$ 패턴 과 일치해야 합니다.

      • 포트 integer(int32) 필수 사항

        경량 디렉토리 액세스 프로토콜 (LDAP) 호스트가 클라이언트 연결을 수신하는 IANA 포트입니다.

        기본값은 636 입니다.

    • requestId 문자열

      경량 디렉토리 액세스 프로토콜( LDAP ) 구성을 확인하기 위해 이 요청 식별하는 고유한 24-16진수 문자열입니다.

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

    • 상태 문자열

      TLS(전송 계층 보안) 구성을 통한 LDAP(Lightweight Directory Access Protocol)의 상태를 나타내는 사람이 읽을 수 있는 문자열입니다.

      값은 FAIL, PENDING 또는 SUCCESS입니다.

    • 유효성 검사 배열[객체]

      TLS(전송 계층 보안)를 통해 제공된 LDAP (Lightweight Directory Access Protocol) 구성 세부 정보의 확인과 관련된 유효성 검사 메시지가 포함된 목록입니다. 이 목록에는 MongoDB Cloud가 실행하는 각 테스트에 대한 문서 포함되어 있습니다. MongoDB Cloud는 첫 번째 실패 후 테스트 실행 중지합니다.

      전송 계층 보안(TLS) 구성 세부 정보를 통해 제공된 경량 디렉토리 액세스 프로토콜( LDAP )의 확인을 테스트하기 위해 MongoDB Cloud가 실행하는 테스트 중 하나입니다.

      유효성 검사 속성 숨기기 유효성 검사 속성 표시 객체
      • 상태 문자열

        이 검증 테스트의 결과를 나타내는 사람이 읽을 수 있는 문자열입니다.

        값은 FAIL 또는 OK입니다.

      • validationType 문자열

        MongoDB Cloud가 실행하는 이 검증 테스트를 식별하는 인간 판독 가능 레이블.

        값은 AUTHENTICATE, AUTHORIZATION_ENABLED, CONNECT, PARSE_AUTHZ_QUERY, QUERY_SERVER, SERVER_SPECIFIED 또는 TEMPLATE입니다.

  • 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 상태 코드가 반환되었습니다.

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

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

    • 매개변수 배열[객체]

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

    • 이유 문자열

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

GET /API/Atlas/v2/groups/{groupId}/userSecurity/LDAP/verify/{requestId}
atlas api ldapConfiguration getGroupUserSecurityLdapVerify --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/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.GetGroupUserSecurityLdapVerifyApiParams{}
	sdkResp, httpResp, err := client.LDAPConfigurationApi.
		GetGroupUserSecurityLdapVerifyWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true"
응답 예시(200)
{
  "groupId": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "request": {
    "bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
    "caCertificate": "string",
    "hostname": "string",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ],
    "port": 636
  },
  "requestId": "32b6e34b3d91647abb20e7b8",
  "status": "FAIL",
  "validations": [
    {
      "status": "FAIL",
      "validationType": "AUTHENTICATE"
    }
  ]
}
응답 예시(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"
}