ユーザーのリスト
get
/api/v2/organizations/{id}/access_list/
このリソースに対して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: このユーザーが最後に変更されたときのタイムスタンプ。(日時)username: 必須。150文字以下。文字、数字および@/./+/-/_のみ。(文字列)first_name: (文字列)last_name: (文字列)email: (文字列)is_superuser: 明示的に割り当てることなく、このユーザーがすべての権限を持つことを示します。(ブール)is_system_auditor: (ブール)password: パスワードの変更に使用するフィールド。(文字列)ldap_dn: (文字列)last_login: (日時)external_account: アカウントが外部サービスによって管理されている場合に設定します(フィールド)
ソート
ユーザーが特定の順序で返されるように指定するには、GETリクエストでorder_by問合せ文字列パラメータを使用します。
?order_by=username
フィールド名の先頭にダッシュ-を付けると逆の順序でソートされます。
?order_by=-username
フィールド名をカンマ,で区切ると、複数のソート・フィールドを指定できます。
?order_by=username,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レスポンス
ネストされたスキーマ : ResourceAccessListElement
型:
ソースを表示
object- created: 文字列
タイトル:
Created読取り専用:true - email: 文字列
タイトル:
Email address最大長:254 - external_account: 文字列
タイトル:
External account読取り専用:trueアカウントが外部サービスによって管理される場合に設定されます - first_name: 文字列
タイトル:
First name最大長:150 - id: 整数
タイトル:
ID読取り専用:true - is_superuser: ブール
タイトル:
Superuser status明示的に割り当てることなく、このユーザーがすべての権限を持つことを示します。 - is_system_auditor: ブール
タイトル:
Is system auditor - last_login: 文字列(日付-時間)
タイトル:
Last login読取り専用:true - last_name: 文字列
タイトル:
Last name最大長:150 - ldap_dn: 文字列
タイトル:
Ldap dn読取り専用:true最小長:1 - modified: 文字列
タイトル:
Modified読取り専用:true - password: 文字列
タイトル:
Password最小長:1パスワードの変更に使用されるフィールド。 - related: 文字列
- summary_fields: 文字列
タイトル:
Summary fields読取り専用:true - type: 文字列
タイトル:
Type読取り専用:true - url: 文字列
タイトル:
Url読取り専用:true - username(必須): 文字列
タイトル:
Username最小長:1最大長:150パターン:^[\w.@+-]+$必須。150文字以下。文字、数字および@/./+/-/_のみ。