機械翻訳について

移動先

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

アプリケーションのリスト

get

/api/v2/users/{id}/applications/

このリソースに対して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: このアプリケーションが最後に変更されたときのタイムスタンプ。(日時)
• name: このアプリケーションの名前。(文字列)
• description: このアプリケーションのオプションの説明。(文字列)
• client_id: (文字列)
• client_secret: トークンの作成時にアプリケーションへのアクセスをより厳密に検証するために使用します。(文字列)
• client_type: クライアント・デバイスの安全性に応じて、パブリックまたは機密に設定します。(選択)
  • confidential: 機密
  • public: パブリック
• redirect_uris: 許可されているURIリスト、スペース区切り(文字列)
• authorization_grant_type: このアプリケーションのトークンを取得するためにユーザーが使用する必要がある付与タイプ。(選択)
  • authorization-code: 認可コード
  • password: リソース所有者のパスワードベース
• skip_authorization: Trueに設定すると、完全に信頼できるアプリケーションの認可ステップをスキップします。(ブール)
• organization: このアプリケーションを含む組織。(id)

ソート

アプリケーションが特定の順序で返されるように指定するには、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

パス・パラメータ

• id(required): string

問合せパラメータ

• 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/OAuth2Application"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

• Array of: object OAuth2Application

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

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

型: object

ソースを表示

• authorization_grant_type(required): string
  タイトル: Authorization Grant Type

  指定できる値: [ "authorization-code", "password" ]

  ユーザーがこのアプリケーションのトークンの取得に使用する必要がある権限付与タイプ。
• client_id: string
  タイトル: Client id

  読取り専用: true

  最小長: 1
• client_secret: string
  タイトル: Client Secret

  読取り専用: true

  最小長: 1

  トークンの作成時にアプリケーションへのアクセスをより厳密に検証するために使用されます。
• client_type(required): string
  タイトル: Client Type

  指定できる値: [ "confidential", "public" ]

  クライアント・デバイスのセキュリティ保護方法に応じて、パブリックまたは機密に設定します。
• created: string
  タイトル: Created

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

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

  読取り専用: true
• name(required): string
  タイトル: Name

  最大長: 255
• organization(required): integer
  タイトル: Organization

  このアプリケーションを含む組織。
• redirect_uris: string
  タイトル: Redirect URIs

  許可されたURIリスト、スペース区切り
• related: string
  タイトル: Related

  読取り専用: true
• skip_authorization: boolean
  タイトル: Skip Authorization

  Trueを設定すると、完全に信頼できるアプリケーションの承認ステップをスキップできます。
• summary_fields: string
  タイトル: Summary fields

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

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

  読取り専用: true

{
    "properties":{
        "authorization_grant_type":{
            "description":"The Grant type the user must use for acquire tokens for this application.",
            "enum":[
                "authorization-code",
                "password"
            ],
            "title":"Authorization Grant Type",
            "type":"string",
            "x-nullable":true
        },
        "client_id":{
            "minLength":"1",
            "readOnly":true,
            "title":"Client id",
            "type":"string",
            "x-nullable":true
        },
        "client_secret":{
            "description":"Used for more stringent verification of access to an application when creating a token.",
            "minLength":"1",
            "readOnly":true,
            "title":"Client Secret",
            "type":"string",
            "x-nullable":true
        },
        "client_type":{
            "description":"Set to Public or Confidential depending on how secure the client device is.",
            "enum":[
                "confidential",
                "public"
            ],
            "title":"Client Type",
            "type":"string",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"Id",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"255",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"Organization containing this application.",
            "title":"Organization",
            "type":"integer"
        },
        "redirect_uris":{
            "description":"Allowed URIs list, space separated",
            "title":"Redirect URIs",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "skip_authorization":{
            "description":"Set True to skip authorization step for completely trusted applications.",
            "title":"Skip Authorization",
            "type":"boolean",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name",
        "client_type",
        "authorization_grant_type",
        "organization"
    ],
    "type":"object"
}

先頭に戻る