プログラムによる組織へのアクセスを管理
- Atlas へのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、Atlas Administration APIへのリクエストで使用する サービス アカウントを作成します。
プログラムによって組織へのアクセスを管理するには、次の手順に従います。 詳細については、「組織へのプログラムによるアクセスの付与 」を参照してください。
必要なアクセス権
次のいずれかのアクションを実行するには、Atlas に対する Organization Owner
アクセス権が必要です。
組織へのプログラムによるアクセスの表示
組織へのアクセス権を持つすべての APIキーまたはサービス アカウントの詳細を表示できます。
Atlas CLI を使用して、組織内の API キーのリスト、 API キーの詳細、または API キーのアクセス リストを表示できます。
API キーの表示
Atlas CLI を使用して組織内のすべての API キーを一覧表示するには、次のコマンドを実行します。
atlas organizations apiKeys list [options]
Atlas CLI を使用して組織内の API キーの詳細を返すには、次のコマンドを実行します。
atlas organizations apiKeys describe <ID> [options]
前のコマンドの構文とパラメーターの詳細については、 Atlas CLIドキュメントの「 Atlas organizations apiKeys list 」と「 Atlas organizations apiKeys describe 」を参照してください。
APIキーのAPIアクセス リスト エントリの表示
Atlas CLI を使用して API キーの IP アクセス リスト エントリを一覧表示するには、次のコマンドを実行します。
atlas organizations apiKeys accessLists list <apiKeyID> [options]
コマンド構文とパラメーターの詳細については、 Atlas CLIドキュメントの「 Atlas organizations apiKeys accessLists list 」を参照してください。
Atlas UI を使用して、組織内のAPIキーの詳細を表示するには、次のようにします。
Atlas で、 Organization Access Manager ページに移動します。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからOrganization Accessを選択します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
Atlas で、Organization Access Manager ページに移動します。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからOrganization Accessを選択します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
Atlas Administration APIを使用して、組織にアクセスできるサービス アカウントの名前と詳細を一覧表示できます。
組織へのプログラムによるアクセスを更新
Atlas CLI を使用して、組織内のAPIキーのロールまたはアクセス リストを変更できます。
APIキーのロールの変更
Atlas CLI を使用して組織で API キーを更新するには、次のコマンドを実行します。
atlas organizations apiKeys assign <apiKeyId> [options]
コマンド構文とパラメーターの詳細については、 Atlas CLIドキュメントの「 Atlas organizations apiKeys assign 」を参照してください。
APIキーのAPIアクセス リスト エントリの追加
Atlas CLI を使用して API キーの IP アクセス リスト エントリを作成するには、次のコマンドを実行します。
atlas organizations apiKeys accessLists create [options]
コマンド構文とパラメーターの詳細については、Atlas CLI ドキュメントの「atlas organizations apiKeys accessLists create」を参照してください。
APIキーのAPIアクセス リスト エントリの削除
Atlas CLI を使用して API キーの IP アクセス リスト エントリを削除するには、次のコマンドを実行します。
atlas organizations apiKeys accessLists delete <entry> [options]
コマンド構文とパラメーターの詳細については、 Atlas CLIドキュメントの「 Atlas organizations apiKeys accessLists delete 」を参照してください。
Atlas UI を使用して、組織内のAPIキーのロール、説明、またはアクセス リストを変更できます。
Atlas で、Organization Access Manager ページに移動します。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからOrganization Accessを選択します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
API Key Informationを編集します。
[Add API Key] ページで次を行います。
Descriptionを変更します。
Organization Permissions メニューで、API キーの新しいロールを選択します。
Atlas UIを使用して、組織内のサービス アカウントのロール、名前、説明、またはアクセス リストを変更できます。 新しいクライアントシークレットを生成することもできます。
Atlas で、Organization Access Manager ページに移動します。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからOrganization Accessを選択します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
Organization Permissionsを編集します。
[Edit Permissions] をクリックします。
Organization Permissionsメニューから、サービス アカウントの 新しいロール を選択します。
[Save and next] をクリックします。
重要
サービス アカウントの認証情報は、期限切れまたは取り消されるまでアクティブのままになります。
Atlas Administration APIを使用して、次のことが可能です。
組織へのプログラムによるアクセスを取り消す
Atlas CLI を使用して組織から API キーを削除するには、次のコマンドを実行します。
atlas organizations apiKeys delete <ID> [options]
コマンド構文とパラメーターの詳細については、 Atlas CLIドキュメントの「 Atlas organizations apiKeys delete 」を参照してください。
組織 内のAPIキーのアクセス リスト エントリを削除するには、「組織へのプログラムによるアクセスの更新 」を参照してください。
Atlas で、Organization Access Manager ページに移動します。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからOrganization Accessを選択します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
Atlas で、Organization Access Manager ページに移動します。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからOrganization Accessを選択します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
Atlas Administration APIを使用して、次のことが可能です。