ページネーションによって結果を「ページング」することで、単一のAPIリクエストの制限で許容されるよりも多くの結果が返されます。この記事では、多くのOkta APIリストエンドポイントでサポートされているページネーションの概要について説明します。

• API呼び出し
• Postman
• ページネーション

結果のリストをリクエストするときにlimitパラメーターの値を指定しない場合は（ユーザーの一覧表示APIなど）、最大値（200）がデフォルトとして使用されます。この制限よりも多くの結果を返すには、ページネーションが必要です。

この例では、ユーザーAPIからユーザーの一覧表示を使用しています。

1. Postmanで、ユーザーの一覧表示API呼び出しを生成します： {{url}}/api/v1/users?limit=200。
2. ［送信］をクリックします。
3. ［Response（応答）］で、［ヘッダー］に移動します。
4. ［ヘッダー］タブには、2つのリンクヘッダーがあります。関連するヘッダーは、rel="next"が含まれているヘッダーです。
   • そのヘッダーで、以下を確認してください。
     • <https://orgname.okta.com/api/v1/users?after=*****************&limit=200>; rel="next."
5. 上記の太字で強調表示されている部分を、ステップ4で説明したリンクヘッダーからコピーします。
6. 新しいユーザーの一覧表示API呼び出しを作成します（［ユーザーの一覧表示］の左側のメニューを右クリック > ［新しいタブで開く］）。
7. APIリクエストの「?」の後のリンクヘッダーからコピーした部分を貼り付けます。
8. これにより、このAPI呼び出しの応答本文の次のページに結果が返されます。
9. 応答にrel="next"が含まれているリンクヘッダーがなくなると、それ以上の結果は返されなくなります。

結果を自動的に返すには、スクリプトでこのプロセスを使用します。詳細については、以下の関連資料を参照してください。
 

注：特定のエンドポイントパラメーターでは、ページネーションがサポートされていない場合があります。たとえば、管理者がユーザーの検索にqパラメーターを使用している場合、デフォルトの制限は10であり、このパラメーターではページネーションがサポートされていません。管理者が使用しているエンドポイントについて、それぞれのOkta開発者APIの資料を参照してください。

関連資料

• Core Okta API - 設計原則 - ページネーション
• Core Okta API - ユーザーAPI - ユーザーの一覧表示