ユーザーのロールのリスト
get
/api/v2/users/{id}/roles/
このリソースに対してGETリクエストを行って、選択したユーザーに関連付けられたロールのリストを取得します。
結果のデータ構造には次が含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
countフィールドは、対象となる問合せで見つかったロールの合計数を示します。 nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 resultsリストには、0個以上のロール・レコードが含まれます。
結果
それぞれのロール・データ構造には次のフィールドが含まれます。
id: このロールのデータベースID。(整数)type: このロールのデータ型。(選択)url: このロールのURL。(文字列)related: 関連リソースのURLを含むデータ構造。(オブジェクト)summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)name: このロールの名前。(フィールド)description: このロールのオプションの説明。(フィールド)
ソート
ロールが特定の順序で返されるように指定するには、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":[
{
"description":"User is a member of the organization",
"id":10,
"name":"Member",
"related":{
"organization":"/api/v2/organizations/1/",
"teams":"/api/v2/roles/10/teams/",
"users":"/api/v2/roles/10/users/"
},
"summary_fields":{
"resource_id":1,
"resource_name":"test-org",
"resource_type":"organization",
"resource_type_display_name":"Organization",
"user_capabilities":{
"unattach":false
}
},
"type":"role",
"url":"/api/v2/roles/10/"
}
]
}