組織の管理ユーザーのリスト
get
/api/v2/organizations/{id}/admins/
このリソースに対してGETリクエストを行って、選択した組織に関連付けられた管理ユーザーのリストを取得します。
結果のデータ構造には次が含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
countフィールドは、対象となる問合せで見つかった管理ユーザーの合計数を示します。 nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 resultsリストには、0個以上の管理ユーザー・レコードが含まれます。
結果
それぞれの管理ユーザーのデータ構造には次のフィールドが含まれます。
id: このユーザーのデータベースID。(整数)type: このユーザーのデータ型。(選択)url: このユーザーのURL。(文字列)related: 関連リソースのURLを含むデータ構造。(オブジェクト)summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created: このユーザーが作成されたときのタイムスタンプ。(日時)username: 必須。150文字以下。 文字、数字および@/./+/-/_のみ。(文字列)first_name: (文字列)last_name: (文字列)email: (文字列)is_superuser: 明示的に割り当てることなく、このユーザーがすべての権限を持つことを示します。(ブール)-
is_system_auditor: (ブール) -
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レスポンス
レスポンスの例(application/json)
{
"count":1,
"next":null,
"previous":null,
"results":[
{
"auth":[
],
"created":"2018-02-01T08:00:00.000000Z",
"email":"",
"external_account":null,
"first_name":"",
"id":2,
"is_superuser":false,
"is_system_auditor":false,
"last_login":null,
"last_name":"",
"ldap_dn":"",
"related":{
"access_list":"/api/v2/users/2/access_list/",
"activity_stream":"/api/v2/users/2/activity_stream/",
"admin_of_organizations":"/api/v2/users/2/admin_of_organizations/",
"authorized_tokens":"/api/v2/users/2/authorized_tokens/",
"credentials":"/api/v2/users/2/credentials/",
"organizations":"/api/v2/users/2/organizations/",
"personal_tokens":"/api/v2/users/2/personal_tokens/",
"projects":"/api/v2/users/2/projects/",
"roles":"/api/v2/users/2/roles/",
"teams":"/api/v2/users/2/teams/",
"tokens":"/api/v2/users/2/tokens/"
},
"summary_fields":{
"user_capabilities":{
"delete":false,
"edit":false
}
},
"type":"user",
"url":"/api/v2/users/2/",
"username":"alice"
}
]
}