認証情報リストの API エンドポイント¶

このリソースに GET リクエストを実行して、認証情報リストを取得します。

GET /api/v2/credentials/
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept
X-API-Node: localhost
X-API-Time: 0.129s


{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

count フィールドはクエリーで見つかった認証情報の合計数を示します。next および previous フィールドは、単一ページに収まらない結果がある場合に、それらの結果へのリンクを提供します。results には認証情報のレコードが一覧表示されますが、ゼロの場合もあります。

結果¶

各認証情報のデータ構造には以下のフィールドが含まれます。

id: 認証情報のデータベース ID (整数)
type: 認証情報のデータタイプ (選択)
- credential: 認証情報
url: 認証情報の URL (文字列)
related: 関連リソースの URL のあるデータ構造 (オブジェクト)
summary_fields: 関連リソースの名前/説明のあるデータ構造 (オブジェクト)
created: 認証情報作成時のタイムスタンプ (日時)
modified: 認証情報の最終更新時のタイムスタンプ (日時)
name: 認証情報の名前 (文字列)
description: 認証情報のオプションでの説明 (文字列)
organization: 組織ロールからパーミッションを継承します。作成時に提供する場合は、ユーザーまたはチームのいずれも指定しないでください (フィールド)
credential_type: 作成する認証情報のタイプを指定します。各タイプの詳細については、Ansible Tower のドキュメントを参照してください。(フィールド)
inputs: JSON または YAML 構文のいずれかを使用して inputs を入力します。ラジオボタンを使用してこれら 2 つを切り替えます。構文例については、Ansible Tower のドキュメントを参照してください。(フィールド)

並び替え¶

特定の順番で認証情報が返されることを指定するには、order_by クエリー文字列のパラメーターを GET リクエストで使用します。

?order_by=name

逆の順序に並び替えるには、フィールド名の前にダッシュ - を加えます。

?order_by=-name

フィールド名をコンマ , 区切りにすると、複数のフィールドの並び替えを指定できます。

?order_by=name,some_other_field

ページネーション¶

各リクエストで返される結果数を変更するには、page_size クエリー文字列パラメーターを使用します。特定のページの結果を取得するには、page クエリー文字列パラメーターを使用します。

?page_size=100&amp;page=2

結果で返される previous および next のリンクは、これらのクエリー文字列パラメーターを自動的に設定します。

検索¶

モデルの指定された全テキストフィールド内で大文字小文字の区別のない検索を実行するには、search クエリー文字列のパラメーターを使用します。

?search=findme

関連フィールドを検索します (AWX 1.4 / Ansible Tower 3.1 で追加)。

?related__search=findme

フィルタリング¶

特定の値に一致する結果一覧に対して、追加のクエリー文字列パラメーターを使ってフィルタリングすることもできます。このフィルタリングに使用できるのは、データベースに存在するフィールドと関係のみです。指定された値の特殊文字は、エンコードされた URL にする必要があります。例を示します。

?field=value%20xyz

フィールドは関係にまで及ぶ可能性がありますが、その場合はデータベースで定義されたフィールドと関係に限定されます。

?other__field=value

特定の基準に一致する結果を除外するには、フィールドパラメーターの前に not__ を追加します。

?not__field=value

デフォルトでは、クエリー文字列フィルターはすべて AND 条件になっているので、すべての フィルターに一致する結果のみが返されます (AWX 1.4 で追加)。複数基準の いずれか に一致する結果にまとめるには、各クエリー文字列パラメーターの前に or__ を追加します。

?or__field=value&amp;or__field=othervalue
?or__not__field=value&amp;or__field=othervalue

デフォルトの AND 条件のフィルタリングでは、データベース関係全体でフィルタリングされている関連オブジェクトそれぞれに同時に全フィルターが適用されます (Ansible Tower 1.4.5 で追加) 。チェーンフィルター (chain) では、フィルターを個別に関連オブジェクトごとに適用します。これを使用するには、chain__ をクエリー文字列パラメーターの前に追加します。

?chain__related__field=value&amp;chain__related__field2=othervalue
?chain__not__related__field=value&amp;chain__related__field2=othervalue

上記で最初のクエリーが ?related__field=value&related__field2=othervalue となっていれば、同一の関連オブジェクトが両方の条件を満たしているプライマリーオブジェクトのみが返されますが、上記通りのチェーンフィルターを使用すると、各条件に一致するプライマリーオブジェクトの共通集合が返されます。

フィールド名に lookup を追加すると、より詳細なクエリーによるフィールドルックアップが可能になります。

?field__lookup=value

以下のフィールドのルックアップがサポートされています。

exact: 完全一致 (指定されない場合のデフォルトのルックアップ)
iexact: 大文字小文字の区別のない exact
contains: フィールドに値を含む
icontains: 大文字小文字の区別のない contains
startswith: 値で始まるフィールド
istartswith: 大文字小文字の区別のない startswith
endswith: 値で終わるフィールド
iendswith: 大文字小文字の区別のない endswith
regex: 特定の正規表現に一致するフィールド
iregex: 大文字小文字の区別のない regex
gt: Greater than の比較条件
gte: Greater than or equal to の比較条件
lt: Less than の比較条件
lte: Less than or equal to の比較条件
isnull: 特定フィールドもしくは関連オブジェクトが null かどうかをチェック。ブール値を想定
in: 特定フィールドの値が提供されたリストに存在するかどうかをチェック。アイテムのリストを想定

ブール値は true の場合 True または 1 を、false の場合は False または 0 を指定します (どちらも大文字小文字の区別なし)。

Null 値は None または Null (どちらも大文字小文字の区別なし) を指定できますが、isnull ルックアップを使用して明示的に null 値をチェックすることが推奨されます。

in ルックアップのリストは、値をコンマ区切りのリストとして指定することができます。

クエリー文字列のパラメーターによるユーザーのアクセスレベルのリクエストをベースにしたフィルタリング (Ansible Tower 3.1 で追加)。

role_level: フィルターをかけるロールのレベル。例、admin_role

認証情報の作成¶

新規認証情報を作成するには、以下の認証情報フィールドを使ってリソースに POST リクエストを実行します。

name: 認証情報の名前 (文字列、必須)
description: 認証情報のオプションでの説明 (文字列。デフォルトは "")
organization: 組織ロールからパーミッションを継承します。作成時に提供する場合は、ユーザーまたはチームのいずれも指定しないでください (フィールド。デフォルトは None)
user: ユーザーを所有者ロールに追加するために使用される書き込み専用フィールドです。提供する場合は、チームまたは組織のいずれも指定しないでください。作成時にのみ有効です。(フィールド。デフォルトは None)
team: チームを所有者ロールに追加するために使用される書き込み専用フィールドです。提供する場合は、ユーザーまたは組織のいずれも指定しないでください。作成時にのみ有効です。(フィールド。デフォルトは None)
credential_type: 作成する認証情報のタイプを指定します。各タイプの詳細については、Ansible Tower のドキュメントを参照してください。(フィールド。必須)
inputs: JSON または YAML 構文のいずれかを使用して inputs を入力します。ラジオボタンを使用してこれら 2 つを切り替えます。構文例については、Ansible Tower のドキュメントを参照してください。(フィールド。デフォルトは None)

オプションエンドポイントの確認¶

オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な API でエンドポイントを表示している場合は、「オプション」ボタンをクリックすると以下の raw JSON が表示されます。

name

Credential List

description

# List Credentials: Make a GET request to this resource to retrieve the list of credentials.

renders

0	application/json
1	text/html

parses

0	application/json

added_in_version

1.2

actions

POST

name

type	string
required	true
label	Name
max_length	512
help_text	Name of this credential.

description

type	string
required	false
label	Description
help_text	Optional description of this credential.
default	(Empty Text)

organization

type	field
required	false
label	Organization
help_text	Inherit permissions from organization roles. If provided on creation, do not give either user or team.
default	null

user

type	field
required	false
label	User
help_text	Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation.
default	null
write_only	true

team

type	field
required	false
label	Team
help_text	Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation.
default	null
write_only	true

credential_type

type	field
required	true
label	Credential type
help_text	Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type.

inputs

type	field
required	false
label	Inputs
help_text	Enter inputs using either JSON or YAML syntax. Use the radio button to toggle between the two. Refer to the Ansible Tower documentation for example syntax.
default	(Empty Object)

GET

id

type	integer
label	ID
help_text	Database ID for this credential.

type

choice

label

Type

help_text

Data type for this credential.

choices

0

0	credential
1	Credential

url

type	string
label	Url
help_text	URL for this credential.

type	object
label	Related
help_text	Data structure with URLs of related resources.

summary_fields

type	object
label	Summary fields
help_text	Data structure with name/description for related resources.

created

type	datetime
label	Created
help_text	Timestamp when this credential was created.

modified

type	datetime
label	Modified
help_text	Timestamp when this credential was last modified.

name

type	string
label	Name
help_text	Name of this credential.

description

type	string
label	Description
help_text	Optional description of this credential.

organization

type	field
label	Organization
help_text	Inherit permissions from organization roles. If provided on creation, do not give either user or team.

credential_type

type	field
label	Credential type
help_text	Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type.

inputs

type	field
label	Inputs
help_text	Enter inputs using either JSON or YAML syntax. Use the radio button to toggle between the two. Refer to the Ansible Tower documentation for example syntax.

types

0	credential

search_fields

0	description
1	name