ユーザーのリスト
get
/api/v2/instance_groups/{id}/access_list/
このリソースに対するGETリクエストを実行して、ユーザーのリストを取得します。
結果のデータ構造には次のものが含まれます:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
countフィールドは、特定の問合せに対して見つかったユーザーの合計数を示します。 nextフィールドとpreviousフィールドには、単一ページに収まる以上の結果へのリンクが表示されます。 resultsリストには、ゼロ以上のユーザー・レコードが含まれています。
結果
各ユーザー・データ構造には次のフィールドが含まれます:
id: このユーザーのデータベースID。(integer)type: このユーザーのデータ型。(choice)url: このユーザーのURL。(string)related: 関連リソースのURLを持つデータ構造。(オブジェクト)summary_fields: 関連リソースの名前/説明を持つデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created: このユーザーが作成されたタイムスタンプ。(datetime)modified: このユーザーが最後に変更されたタイムスタンプ。(日時)username: 必須。150文字以下。 文字、数字および@/./+/-/_のみ。(string)first_name: (文字列)last_name: (文字列)email: (文字列)is_superuser: 明示的に割り当てることなく、このユーザーにすべての権限があることを指定します。(boolean)is_system_auditor: (boolean)password: パスワードの変更に使用するフィールド。(文字列)ldap_dn: (文字列)last_login: (日時)external_account: アカウントが外部サービス(field)によって管理される場合に設定
ソート
ユーザーが特定の順序で返されることを指定するには、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タワー3.1.0で追加」)関連フィールド全体を検索します:
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- page: integer
ページ区切り結果セット内のページ番号。
- page_size: integer
ページ当たりに返す結果の数。
- search: string
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
ネストされたスキーマ : ResourceAccessListElement
型:
ソースを表示
object- created: string
タイトル:
Created読取り専用:true - email: string
タイトル:
Email address最大長:254 - external_account: string
タイトル:
External account読取り専用:trueアカウントが外部サービスによって管理されるかどうかを設定 - first_name: string
タイトル:
First name最大長:150 - id: integer
タイトル:
ID読取り専用:true - is_superuser: boolean
タイトル:
Superuser status明示的に割り当てることなく、このユーザーにすべての権限があることを指定します。 - is_system_auditor: boolean
タイトル:
Is system auditor - last_login: string(date-time)
タイトル:
Last login読取り専用:true - last_name: string
タイトル:
Last name最大長:150 - ldap_dn: string
タイトル:
Ldap dn読取り専用:true最小長:1 - modified: string
タイトル:
Modified読取り専用:true - password: string
タイトル:
Password最小長:1パスワードの変更に使用するフィールド。 - related: string
- summary_fields: string
タイトル:
Summary fields読取り専用:true - type: string
タイトル:
Type読取り専用:true - url: string
タイトル:
Url読取り専用:true - username(required): string
タイトル:
Username最小長:1最大長:150パターン:^[\w.@+-]+$必須。150文字以下。 文字、数字および@/./+/-/_のみ。