OCIのAPI認証の設定

ローカル環境をOCIテナンシに接続するには、構成ファイルにAPI認証を設定します。

始める前に

このチュートリアルを正常に実行するには、次の構成が必要です。

  • サポートされているブラウザ
  • Windows Subsystem for Linux (WSL)を使用したMacOS、LinuxまたはWindows環境。
  • Python 3がインストールされています。サポートされているPythonのバージョンについては、Python SDKのドキュメントを参照してください。
  • Python 3がインストールされています。
  • 「チュートリアル用のサンドボックス・ユーザーの作成」チュートリアルを実行し、次を実行します。
    • Oracle Mobile Authenticatorアプリケーションを準備します。
    • チュートリアルから次の情報を書き留めます。
      • <サンドボックス・ユーザー名>
      • <サンドボックス・ユーザー・パスワード>
      • <tenancy-name>
      • <domain-name>
      • <サンドボックス・コンパートメント>

1.APIキーの作成

このチュートリアルでは、コンソールでサンドボックス・ユーザーの秘密キーと公開キーのペアを生成します。コンソールを使用してキー・ペアを追加すると、コンソールによって構成ファイルのプレビュー・スニペットも生成されます。

  1. コンソールにサインインします。「クラウド・アカウント名」<tenancy-name>と入力し、「次へ」を選択します。
  2. アイデンティティ・ドメインの場合は、<domain-name>を入力します。たとえば、「デフォルト」を選択し、「次へ」を選択します。
  3. <sandbox-username>および<sandbox-user-password>を入力し、「サインイン」を選択します。
  4. Oracle Mobile Authenticatorアプリケーションを開き、<tenancy-name> <sandbox-username>アカウントに対して生成されたパスコードを取得します。
  5. コンソールの「マルチファクタ認証」ウィンドウで、パスコードを入力し、「サインイン」を選択します。
    コンソールのホーム・ページが表示されます。
  6. 上部のナビゲーション・バーで、「プロファイル」アイコンを選択し、「ユーザー設定」を選択します。
  7. 「トークンとキー」を選択します。
  8. 「APIキー」で、「APIキーの追加」を選択します。
  9. ダイアログの指示に従ってキーを生成または指定します。
    重要

    キーを生成する場合は、両方のキーをダウンロードし、キーを安全な場所に保存します。キーを失った場合、キーは再作成できず、新しいキーを再度作成する必要があります。
  10. 「追加」を選択します。
  11. ダイアログに構成設定が表示されます。構成情報をローカル環境のconfigというファイルにコピーし、ファイルをセキュアなテキスト・ファイルに保存します。

ヘルプが必要な場合は、API署名の必要なキーおよびOCIDsを参照してください。

2. キー権限の変更

  1. 前のセクションのキーをダウンロードしたフォルダに移動します。
  2. (オプション)キーの名前を変更します。たとえば、<sandbox-user-private-key.pem>および<sandbox-user-public-key.pem>です。
  3. ターミナルから、ホーム・ディレクトリに移動します。
  4. .ociディレクトリを作成します。
  5. 公開キーと秘密キーを.ociディレクトリに移動し、<path-to-private-key.pem>を書き留めます。
    例: <home-directory>/.oci/<sandbox-user-public-key.pem>
  6. ローカル環境で、次のコマンドで秘密キー・ファイルの権限を変更します。
    chmod 400 <path-to-private-key.pem>

4.OCI CLIのインストール

  1. pipを使用してOCI CLIおよびPython SDKをインストールします:
    pip install oci-cli

    必要なライブラリがすべてインストールされます。

  2. OCI CLIがインストールされていることを確認します。次のコマンドを入力します。
    pip list
    このコマンドは、oci-cliを含むインストール済パッケージをリストします。次に例を示します。
    oci-cli                  <version>

4. ローカル構成ファイルの作成

  1. .ociディレクトリから、コマンドtouch configを入力します。
  2. 前の項でコピーしたAPIキー構成データをconfigファイルに貼り付けます。

    configファイルの例。

    [DEFAULT]
    user=<ocid1.user.oc1..xxx>
    fingerprint=<xx:xx:xx:xx>
    tenancy=<ocid1.tenancy.oc1..xxx>
    region=us-chicago-1
    key_file=<path-to-private-key.pem>       

    この構成は、[Default]で指定されているDefaultプロファイル用です。

5. 設定のテスト

OCI CLIが構成ファイルを使用してテナンシに接続していることを確認します。
  1. OCI CLIがインストールされていることを確認します。
    oci

    このコマンドは、CLIで使用可能なコマンドを一覧表示します。

  2. 構成ファイルが機能することを確認してください。
    oci os ns get

    このコマンドにより、テナンシのネームスペースが取得されます。

    oci iam region list

    このコマンドは、テナンシで使用可能なリージョンをリストします。