組織の資格証明のリスト
get
/api/v2/organizations/{id}/credentials/
このリソースに対してGETリクエストを行って、選択した組織に関連付けられた資格証明のリストを取得します。
結果のデータ構造には次が含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
count
フィールドは、対象となる問合せで見つかった資格証明の合計数を示します。 next
フィールドとprevious
フィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 results
リストには、0個以上の資格証明レコードが含まれます。
結果
それぞれの資格証明データ構造には次のフィールドが含まれます。
id
: この資格証明のデータベースID。(整数)type
: この資格証明のデータ型。(選択)url
: この資格証明のURL。(文字列)related
: 関連リソースのURLを含むデータ構造。(オブジェクト)summary_fields
: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created
: この資格証明が作成されたときのタイムスタンプ。(日時)modified
: この資格証明が最後に変更されたときのタイムスタンプ。(日時)name
: この資格証明の名前。(文字列)description
: この資格証明のオプションの説明。(文字列)organization
: 組織ロールから権限を継承します。 作成時に指定する場合は、ユーザーまたはチームを指定しないでください。(id)credential_type
: 作成する資格証明のタイプを指定します。 各タイプの詳細は、Ansible Towerのドキュメントを参照してください。(id)managed_by_tower
: (ブール)inputs
: JSONまたはYAML構文を使用して入力を入力します。 構文例は、Ansible Towerのドキュメントを参照してください。(json)kind
: (フィールド)cloud
: (フィールド)kubernetes
: (フィールド)
ソート
資格証明が特定の順序で返されるように指定するには、GETリクエストでorder_by
問合せ文字列パラメータを使用します。
?order_by=name
フィールド名の先頭にダッシュ-
を付けると逆の順序でソートされます。
?order_by=-name
フィールド名をカンマ,
で区切ると、複数のソート・フィールドを指定できます。
?order_by=name,some_other_field
ページ区切り
リクエストごとに返される結果の数を変更するには、page_size
問合せ文字列パラメータを使用します。 特定のページの結果を取得するには、page
問合せ文字列パラメータを使用します。
?page_size=100&page=2
結果で返されるprevious
リンクおよびnext
リンクは、これらの問合せ文字列パラメータを自動的に設定します。
検索
モデルのすべての指定テキスト・フィールド内で大/小文字を区別しない検索を実行するには、search
問合せ文字列パラメータを使用します。
?search=findme
(Ansible Tower 3.1.0で追加)関連フィールド全体を検索します。
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- page(オプション): 整数
ページ区切りが設定された結果セット内のページ番号。
- page_size(オプション): 整数
ページごとに返す結果の数。
- search(オプション): 文字列
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
レスポンスの例(application/json)
{
"count":0,
"next":null,
"previous":null,
"results":[
]
}