カスタマーマネージドの X.509 を無効化

DELETE /api/atlas/v2/groups/{groupId}/userSecurity/customerX509

アップロードされた認証局を含む、プロジェクトのカスタマー マネージド X.509 設定をクリアし、自己管理型 X.509 を無効にします。

この設定を更新すると、データベースのローリング再起動がトリガーされます。このエンドポイントを使用するには、プロジェクト オーナーのロールが必要です。

path パラメータ

  • グループ ID string 必須

    プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

    : グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

    形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

クエリ パラメータ

  • envelope ブール値

    アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

    デフォルト値はfalseです。

応答

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

    承認済み

    応答属性の非表示 応答属性の表示 オブジェクト
    • customerX509 オブジェクト

      データベースユーザーの TLS 証明書を構成するための設定。

      customerX509 属性を非表示 customerX509 属性の表示 オブジェクト
      • CAS string

        データベースユーザーの認証に必要な CA(Certificate Authority、カスタマー認証局)証明書の連結リスト。 MongoDB Cloud では、これが PEM 形式の証明書であると想定されています。

    • ldap オブジェクト

      指定されたプロジェクトに適用される、TLS(Transport Layer Security)経由の LDAP(Lightweight Directory Access Protocol)設定の詳細。

      LDAP 属性を非表示にする LDAP 属性の表示 オブジェクト
      • authenticationEnabled ブール値

        ユーザーが LDAP(Lightweight Directory Access Protocol)ホストを使用して認証できるかどうかを示すフラグ。

      • authorizationEnabled ブール値

        ユーザーが LDAP(Lightweight Directory Access Protocol)ホストを使用してMongoDB Cloud リソースへのアクセスを許可できるかどうかを示すフラグ。

      • authzQueryTemplate string

        認証されたユーザーに関連付けられた LDAP(Lightweight Directory Access Protocol)グループを取得するためにMongoDB Cloud が実行する LDAPクエリ テンプレート。 MongoDB Cloud はこのパラメーターを{USER} ユーザー認可にのみ使用します。認証されたユーザー名を置き換えるには、Uniform Resource Locator( URL )の プレースホルダーを使用します。クエリは、ホスト名で指定されたホストに関連しています。このクエリの形式は RFC4515 RFC4516 に従います。

        デフォルト値は{USER}?memberOf?baseです。

      • bindUsername string

        MongoDB Cloud が LDAP ホストへの接続に使用する LDAP(Lightweight Directory Access Protocol)ユーザーの完全な DN(Distinguished Name、識別名)。LDAP 識別名の形式は RFC 2253 に従う必要があります。

        形式は次のパターンと一致する必要があります: ^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$

        RFC 2253
      • caCertificate string

        MongoDB Cloud が LDAP(Lightweight Directory Access Protocol)ホストの ID を確認するために使用する CA(Certificate Authority、認証局)証明書。MongoDB Cloudは自己署名証明書を許可しています。割り当てられた値を削除するには、"caCertificate": "" のように空の文字列を渡します。

      • Hostname string

        LDAP(Lightweight Directory Access Protocol)ホストのホスト名または IP(Internet Protocol)アドレスを識別する、人間が判読可能なラベル。このホストは、インターネットにアクセスできるか、クラスターへの VPC(Virtual Private Cloud、仮想プライベートクラウド)ピアリング接続が必要です。

        形式は次のパターンと一致する必要があります: ^([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(Lightweight Directory Access Protocol)ホストがクライアント接続をリッスンするポート。

        デフォルト値は636です。

      • userToDNMapping array[オブジェクト]

        MongoDB Cloud が LDAP(Lightweight Directory Access Protocol)ユーザー名を LDAP DN に変換するために使用する DN(User-to-Distinguished Name、ユーザー名から識別名)マップ。

        MongoDB Cloud が LDAP(Lightweight Directory Access Protocol)ユーザー名を LDAP DN に変換するために使用する DN(User-to-Distinguished Name、ユーザー名から識別名)マップ。

        userToDNMapping 属性を非表示にする userToDNMapping 属性の表示 オブジェクト
        • ldapQuery string

          正規式が一致する LDAP 名を LDAP(Lightweight Directory Access Protocol)クエリのテンプレート。クエリの形式は、 RFC4515 RFC4516 に準拠する必要があります。

        • 一致 string 必須

          MongoDB Cloud が提供する LDAP(Lightweight Directory Access Protocol)ユーザー名と照合するために使用する正規式。かっこで囲まれた各セクションは、置換または ldapQuery テンプレートが使用する正規式キャプチャ グループを表します。

        • 置換 string

          マッチ パラメータで正規式に一致する LDAPユーザー名を LDAP 識別名(DN)に変換する LDAP(Lightweight Directory Access Protocol)識別名(DN)のテンプレート。

  • 401 application/ JSON

    許可されていません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 403 application/ JSON

    Forbidden.

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 404 application/ JSON

    見つかりません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 500 application/ JSON

    内部サーバーエラー。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

DELETE /api/atlas/v2 /groups/{groupId}/userSecurity/customerX509
atlas api x509Authentication disableGroupUserSecurityCustomerX509 --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.DisableGroupUserSecurityCustomerX509ApiParams{}
	httpResp, err := client.X509AuthenticationApi.
		DisableGroupUserSecurityCustomerX509WithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509"
応答の例(202)
{
  "customerX509": {
    "cas": "string",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ]
  },
  "ldap": {
    "authenticationEnabled": true,
    "authorizationEnabled": true,
    "authzQueryTemplate": "{USER}?memberOf?base",
    "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,
    "userToDNMapping": [
      {
        "ldapQuery": "string",
        "match": "(.*)",
        "substitution": "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
      }
    ]
  },
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ]
}
応答の例(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"
}