Access Gateway APIを有効または無効にする

Access Gateway APIを使用すると、プログラマチックインターフェイスで多くのタスクを実行できます。Access Gateway APIを使用するには、Access Gateway管理者UIコンソールで有効にする必要があります。

「Okta Access Gateway API」を参照してください。

Access Gateway APIを有効にする

  1. Access Gateway管理者UIコンソールに進みます。
  2. ［Settings（設定）］タブをクリックします。
  3. ［Access Gateway］ボタンをクリックします。
  4. ［API］セクションを展開します。
  5. ［Scopes（スコープ）］ドロップダウンメニューをクリックします。
  6. リストからスコープを選択します。スコープを選択すると、フィールドに表示されます。必要な場合はさらにスコープを選択します。

    Access Gateway APIを有効にするとスコープをさらに追加することはできません。さらに追加する必要がある場合は、Access Gateway APIを無効にし、正しいスコープを追加してから再度有効にします。

  7. トグルスイッチをクリックして、［Enabled（有効）］を表示します。［API Client Private Key（APIクライアント秘密鍵）］ダイアログが表示されます。
  8. ［Copy to Clipboard（クリップボードにコピー）］をクリックします。このキーは一度しか表示されず、後で取得することはできません。APIクライアント秘密鍵を安全な場所に貼り付けます。APIと通信するには、コードにこのキーが必要になります。
  9. クライアントIDは［API］セクションに表示されます。クライアントIDをコピーして安全な場所に貼り付けます。APIと通信するには、コードにこのIDが必要になります。
  10. コードにAPIクライアント秘密鍵とクライアントIDを追加します。次に例を示します。実際の値で置き換えます。

    [ { "client_id": "nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn", "scope": [ "okta.oag.app.scope" ], "expiration": 0 } ]

  11. JSON Web Token（JWT）を署名します。「Okta Access Gateway API」を参照してください。

Access Gateway APIを無効にする

  1. Access Gateway管理者UIコンソールに進みます。
  2. ［Settings（設定）］タブをクリックします。
  3. ［Access Gateway］ボタンをクリックします。
  4. ［API］セクションを展開します。
  5. トグルスイッチをクリックして、［Disabled（無効）］を表示します。確認ダイアログが表示されます。
  6. ［Yes（はい）］をクリックします。作成したクライアントIDが、Access Gateway APIで利用できなくなりました。
  7. Access Gateway APIと通信するコードから、削除したクライアントIDへの参照とそのスコープを削除します。