グループの検索

検索パラメーターに指定されたプロパティを基にして、Oktaグループを検索します。

グループ検索の詳細については、「OktaグループAPI 」を参照してください。

入力フィールドに値を指定しないでこのカードを実行すると、使用しているOkta orgにあるすべてのグループの情報が返されます。

スコープ

このカードで必要なOAuthスコープのリストは「アクションカード」を参照してください。

オプション

フィールド	定義	タイプ	必須
結果セット（Result Set）	検索結果のフィルタリング方法を選択します。 `First Matching Record`：一致する最初のレコードが返されます。 `First 200 Matching Records`：最初に一致する200レコードを返します。 `Stream Matching Records`：一致するすべてのレコードが親フローからヘルパーフローに渡されます。このオプションを選択すると、ストリーミング用のヘルパーフローを選択したりカスタム拡張可能フィールドを追加したりできるストリーミング（Streaming）入力セクションがカードに追加されます。	ドロップダウン	正

注:

多数のレコードを返す方法については、ヘルパーフローを使ったレコードのストリーミング一致を参照してください。

入力

カードの入力フィールドは、インスタンスのグループプロファイルのプロパティに基づいて動的に生成されます。

カードは、カスタム検索条件（Custom Search Criteria）以外の入力値に対して eq（同等）比較を行います。

フィールド	定義	タイプ	必須
ID (ID)	OktaのグループのID。	テキスト	FALSE
作成日時（Created）	グループが作成されたタイムスタンプ。	テキスト	FALSE
最終アップデート日（Last Updated）	グループのプロファイルが最後に更新された日時のタイムスタンプ。	テキスト	FALSE
最終メンバーシップ更新日時（Last Membership Updated）	グループのメンバーシップが最後に更新された時点のタイムスタンプ。	テキスト	FALSE
タイプ（Type）	グループのプロファイルやメンバーシップの管理に使用されている以下の方法： `OKTA_GROUP`：グループのプロファイルやメンバーシップが、Oktaで静的割り当てを通して直接的、またはグループルールを用いて間接的に管理されます。 `APP_GROUP`：グループのプロファイルやメンバーシップがインポートされ、グループをインポートしたアプリ（Active DirectoryやLDAPなど）内で管理されます。 `BUILT_IN`：Oktaがグループのプロファイルやメンバーシップを管理し、編集はできません。	テキスト	FALSE
名前（Name）	グループの名前。	テキスト	FALSE
説明（Description）	グループの説明。	テキスト	FALSE
Custom Search Criteria (カスタム検索条件)	カスタム文字列を入力して`sw`、`ew`などの比較演算子を使用し、グループプロパティに対して検索を実行します。詳細と例については、「OktaグループAPI」に記載の「検索パラメーター」を参照してください。フィルターや q のクエリパラメーターを使用してグループを検索したい場合には、Custom API Actionカードを使用します。	テキスト	FALSE
ストリーミング（Streaming）
フロー（Flow）	フローの選択（Choose Flow）をクリックして検索結果をストリーミングするヘルパーフローを参照および選択し、選択（Choose）をクリックして確定します。オプションとして、クリックまたはここにドロップして作成（Click or drop here to create）の下の空のフィールドをクリックし、データをヘルパーフローに渡すカスタム拡張可能フィールドを追加します。これらのフィールドは、ヘルパーフロー内の状態（State）出力オブジェクトの下にキーと値のペアとして追加されます。このフィールドは、結果セット（Result Set）オプションで`Stream Matching Records`を選択した場合に表示されます。	フロー	正
検索条件（Search Criteria）
レコード制限（Record Limit）	ストリーミングするレコードの数を指定します。フィールドを`0`未満に設定すると、カードはエラーを返します。フィールドを`0`または`0`より大きい値に設定すると、ストリームは指定された最大数までを返します。フィールドを空またはnullにする、または選択しない場合、ストリームは全レコードを返します。デフォルト値は`1000000`（100万）です。有効な範囲は`0`～`1000000`です。このフィールドは、結果セット（Result Set）オプションで`Stream Matching Records`を選択した場合に表示されます。	数値	FALSE

出力

フィールド	定義	タイプ
未加工オブジェクト（Raw Object）	Okta APIから返される未加工のペイロード。このフィールドは、結果セット（Result Set）オプションで`First Matching Record`を選択した場合に表示されます。	オブジェクト
グループ（Groups）	このグループ分けは、結果セット（Result Set）オプションで`First 200 Matching Records`を選択した場合に表示されます。
ID (ID)	OktaのグループのID。	テキスト
作成日時（Created）	オブジェクトが作成された日時。	テキスト
最終アップデート日（Last Updated）	グループプロファイルが最後に更新された時点のタイムスタンプ。	テキスト
最終メンバーシップ更新日時（Last Membership Updated）	グループのメンバーシップが最後に更新された時点のタイムスタンプ。	テキスト
オブジェクトクラス（Object Class）	グループのプロファイルの限定詞。	テキストのリスト
タイプ（Type）	グループのプロファイルやメンバーシップの管理に使用されている以下の方法： OKTA_GROUP APP_GROUP BUILT_IN	テキスト
プロファイル（Profile）
名前（Name）	グループの名前。	テキスト
説明（Description）	グループの説明。	テキスト
ストリーミングされたレコード（Records Streamed）	ストリーミングフロー内でストリーミングされたレコードの数。このフィールドは、結果セット（Result Set）オプションで`Stream Matching Records`を選択した場合に表示されます。	数値