ユーザーの取得APIで返される結果の数が制限される
Last Updated:
Lifecycle Management
Okta Classic Engine
Okta Identity Engine
Overview
OktaユーザーAPIと検索クエリパラメーターを使用してAPI呼び出しを行った場合、結果には10人のユーザーのみが返されます。
- たとえば、
/api/v1/users?q=nathanを使用してAPI呼び出しを実行すると、より多くのユーザーが返される必要があるときに10人のユーザーのみが返されます。
Applies To
- OktaユーザーAPI
Cause
「q」検索パラメーターを使用した場合、デフォルトでは10人のユーザーのみが返されます。詳細については、Okta APIドキュメントを確認してください。
Solution
この問題は、次の2つの方法のいずれかで解決できます。
- Limitパラメーター
- 10人を超えるユーザー（最大200人）を返すには、検索でlimitパラメーターを使用します。
- たとえば、このAPI呼び出しの形式は次のようになります：
/api/v1/users?q=nathan&limit=200
- たとえば、このAPI呼び出しの形式は次のようになります：
- 10人を超えるユーザー（最大200人）を返すには、検索でlimitパラメーターを使用します。
- searchによるユーザーの一覧表示
- limitパラメーターの代わりに、searchパラメーターを使用することができます。このパラメーターではページネーションがサポートされているため、API呼び出しごとに最大200件、ページネーションを使用する場合はそれ以上の結果を返すことができます。
- たとえば、このAPI呼び出しの形式は次のようになります：
/api/v1/users?search=profile.firstName+eq+%22nathan%22
- たとえば、このAPI呼び出しの形式は次のようになります：
- limitパラメーターの代わりに、searchパラメーターを使用することができます。このパラメーターではページネーションがサポートされているため、API呼び出しごとに最大200件、ページネーションを使用する場合はそれ以上の結果を返すことができます。
注：
- Okta API呼び出しでのページネーションの使用についてサポートが必要な場合は、「PostmanでAPI呼び出しを行うときにページネーションを使用する方法」を参照してください。
- 「Nathan」は例として使用されています。ユースケースに応じて、任意の名に置き換えてください。
