ユーザーのアクセス・トークンのリスト
get
/api/v2/users/{id}/tokens/
このリソースに対して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
: このアクセス・トークンが最後に変更されたときのタイムスタンプ。(日時)description
: このアクセス・トークンのオプションの説明。(文字列)user
: トークン所有者を表すユーザー(id)token
: (文字列)refresh_token
: (フィールド)application
: (id)expires
: (日時)scope
: 許可されるスコープとして、さらにユーザーの権限を制限します。 許可されるスコープ['read', 'write']が指定された、スペースで区切られた単純な文字列である必要があります。(文字列)
ソート
アクセス・トークンが特定の順序で返されるように指定するには、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":[
{
"application":null,
"created":"2018-02-01T08:00:00.000000Z",
"description":"",
"expires":"2018-02-01T08:00:00.000000Z",
"id":2,
"modified":"2018-02-01T08:00:00.000000Z",
"refresh_token":null,
"related":{
"activity_stream":"/api/v2/tokens/2/activity_stream/",
"user":"/api/v2/users/2/"
},
"scope":"read",
"summary_fields":{
"user":{
"first_name":"",
"id":2,
"last_name":"",
"username":"alice"
}
},
"token":"************",
"type":"o_auth2_access_token",
"url":"/api/v2/tokens/2/",
"user":2
}
]
}