Docs Menu
Docs Home
/ /

atlas api ProgrammaticApiKeys deleteAccessEntry

指定された組織APIキーから指定されたアクセス リスト エントリを削除します。

atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。

リソースでは、すべての API リクエストが API アクセスリストの IP アドレスから送信される必要があります。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに読み取り・書き込みロールが必要です。また、リクエスト元の組織の API キーからリクエスト元の IP アドレスを削除することはできません。

1このコマンドは自動生成され、:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2 /操作/ operation-deleteorgapikeyaccesslistentry

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

コマンド構文
atlas api programmaticApiKeys deleteAccessEntry [options]
名前
タイプ
必須
説明

--apiUserId

string

true

アクセス リスト エントリを除きたい組織 API を識別する、ユニークな 24 桁の 16 進数の文字列。

-- envelope

envelope

false

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

-h, --help

false

deleteAccessEntry のヘルプ

--ipAddress

string

true

1 件の IP アドレスまたは複数の IP アドレスを 1 つの CIDR ブロックとして表し、指定した組織内の API リソースへの要求を制限します。192.0.2.0/24 などのサブネット マスクを含む CIDR ブロックを追加する場合は、スラッシュ / の代わりに URL エンコードされた値 %2F を使用します。

--orgId

string

true

プロジェクトを含む組織を識別する一意の 24 桁の 16 進数文字列。 [/orgs](#Tag/Organizations/ 操作/listOrganizations) エンドポイントを使用して、認証されたユーザーがアクセスできるすべての組織を取得します。

-o, --output

string

false

優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。

-- outputFile

string

false

API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。

--pretty

false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

--version

string

false

API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01"

名前
タイプ
必須
説明

-P, --profile

string

false

構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. を参照してください。

atlas api programmaticApiKeys deleteAccessEntry --version 2023-01-01 --apiUserId [apiUserId] --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61

戻る

createProjectApiKey

項目一覧