機械翻訳について

移動先

• リクエスト
• レスポンス

アクセス・トークンのリスト

get

/api/v2/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: integer
  ページ区切りが設定された結果セット内のページ番号。
• page_size: integer
  ページごとに返す結果の数。
• search: string
  検索条件。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

本文()

ルート・スキーマ : schema

型: object

ソースを表示

• count(required): integer
• next: string(uri)
• previous: string(uri)
• results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/OAuth2Token"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

ネストされたスキーマ: results

型: array

ソースを表示

• Array of: object OAuth2Token

{
    "items":{
        "$ref":"#/definitions/OAuth2Token"
    },
    "type":"array"
}

ネストされたスキーマ : OAuth2Token

型: object

ソースを表示

• application: integer
  タイトル: Application
• created: string
  タイトル: Created

  読取り専用: true
• description: string
  タイトル: Description
• expires: string(date-time)
  タイトル: Expires

  読取り専用: true
• id: integer
  タイトル: Id

  読取り専用: true
• modified: string
  タイトル: Modified

  読取り専用: true
• refresh_token: string
  タイトル: Refresh token

  読取り専用: true
• related: string
  タイトル: Related

  読取り専用: true
• scope: string
  タイトル: Scope

  デフォルト値: write

  許可されるスコープは、ユーザー権限をさらに制限します。 許可されるスコープ['read', 'write']を持つ、スペースで区切られた単純な文字列である必要があります。
• summary_fields: string
  タイトル: Summary fields

  読取り専用: true
• token: string
  タイトル: Token

  読取り専用: true
• type: string
  タイトル: Type

  読取り専用: true
• url: string
  タイトル: Url

  読取り専用: true
• user: integer
  タイトル: User

  読取り専用: true

  トークン所有者を表すユーザー

{
    "properties":{
        "application":{
            "title":"Application",
            "type":"integer",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "expires":{
            "format":"date-time",
            "readOnly":true,
            "title":"Expires",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"Id",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "refresh_token":{
            "readOnly":true,
            "title":"Refresh token",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scope":{
            "default":"write",
            "description":"Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].",
            "title":"Scope",
            "type":"string",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "token":{
            "readOnly":true,
            "title":"Token",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "user":{
            "description":"The user representing the token owner",
            "readOnly":true,
            "title":"User",
            "type":"integer"
        }
    },
    "type":"object"
}

先頭に戻る