List Applications

get

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

Make a GET request to this resource to retrieve the list of applications.

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

The count field indicates the total number of applications found for the given query. The next and previous fields provides links to additional results if there are more than will fit on a single page. The results list contains zero or more application records.

Results

Each application data structure includes the following fields:

  • id: Database ID for this application. (integer)
  • type: Data type for this application. (choice)
  • url: URL for this application. (string)
  • related: Data structure with URLs of related resources. (object)
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
  • created: Timestamp when this application was created. (datetime)
  • modified: Timestamp when this application was last modified. (datetime)
  • name: Name of this application. (string)
  • description: Optional description of this application. (string)
  • client_id: (string)
  • client_secret: Used for more stringent verification of access to an application when creating a token. (string)
  • client_type: Set to Public or Confidential depending on how secure the client device is. (choice)
    • confidential: Confidential
    • public: Public
  • redirect_uris: Allowed URIs list, space separated (string)
  • authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice)
    • authorization-code: Authorization code
    • password: Resource owner password-based
  • skip_authorization: Set True to skip authorization step for completely trusted applications. (boolean)
  • organization: Organization containing this application. (id)

Sorting

To specify that applications are returned in a particular order, use the order_by query string parameter on the GET request.

?order_by=name

Prefix the field name with a dash - to sort in reverse:

?order_by=-name

Multiple sorting fields may be specified by separating the field names with a comma ,:

?order_by=name,some_other_field

Pagination

Use the page_size query string parameter to change the number of results returned for each request. Use the page query string parameter to retrieve a particular page of results.

?page_size=100&page=2

The previous and next links returned with the results will set these query string parameters automatically.

Searching

Use the search query string parameter to perform a case-insensitive search within all designated text fields of a model.

?search=findme

(Added in Ansible Tower 3.1.0) Search across related fields:

?related__search=findme

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

200 Response

Back to Top