資格証明の資格証明入力ソースのリスト
get
/api/v2/credentials/{id}/input_sources/
このリソースに対して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: この資格証明入力ソースが最後に変更されたときのタイムスタンプ。(日時)description: この資格証明入力ソースのオプションの説明。(文字列)input_field_name: (文字列)metadata: (json)target_credential: (id)source_credential: (id)
ソート
資格証明入力ソースが特定の順序で返されるように指定するには、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":1,
"next":null,
"previous":null,
"results":[
{
"created":"2018-02-01T08:00:00.000000Z",
"description":"",
"id":1,
"input_field_name":"vault_password",
"metadata":{
"key":"some_key"
},
"modified":"2018-02-01T08:00:00.000000Z",
"related":{
"source_credential":"/api/v2/credentials/2/",
"target_credential":"/api/v2/credentials/1/"
},
"source_credential":2,
"summary_fields":{
"source_credential":{
"cloud":false,
"credential_type_id":2,
"description":"",
"id":2,
"name":"external-cred"
},
"target_credential":{
"cloud":false,
"credential_type_id":1,
"description":"",
"id":1,
"kind":"vault",
"name":"test-cred"
},
"user_capabilities":{
"delete":true
}
},
"target_credential":1,
"type":"credential_input_source",
"url":"/api/v2/credential_input_sources/1/"
}
]
}