Jump to

• Request
• Response

List Applications for an Organization

get

/api/v2/organizations/{id}/applications/

Make a GET request to this resource to retrieve a list of applications associated with the selected organization.

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

• application/json

Path Parameters

• id(required): string

Query Parameters

• page: integer
  A page number within the paginated result set.
• page_size: integer
  Number of results to return per page.
• search: string
  A search term.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : schema

Type: object

Show Source

• 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"
}

Nested Schema : results

Type: array

Show Source

• Array of: object OAuth2Application

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

Nested Schema : OAuth2Application

Type: object

Show Source

• authorization_grant_type(required): string
  Title: Authorization Grant Type

  Allowed Values: [ "authorization-code", "password" ]

  The Grant type the user must use for acquire tokens for this application.
• client_id: string
  Title: Client id

  Read Only: true

  Minimum Length: 1
• client_secret: string
  Title: Client Secret

  Read Only: true

  Minimum Length: 1

  Used for more stringent verification of access to an application when creating a token.
• client_type(required): string
  Title: Client Type

  Allowed Values: [ "confidential", "public" ]

  Set to Public or Confidential depending on how secure the client device is.
• created: string
  Title: Created

  Read Only: true
• description: string
  Title: Description
• id: integer
  Title: Id

  Read Only: true
• modified: string
  Title: Modified

  Read Only: true
• name(required): string
  Title: Name

  Maximum Length: 255
• organization(required): integer
  Title: Organization

  Organization containing this application.
• redirect_uris: string
  Title: Redirect URIs

  Allowed URIs list, space separated
• related: string
  Title: Related

  Read Only: true
• skip_authorization: boolean
  Title: Skip Authorization

  Set True to skip authorization step for completely trusted applications.
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: 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"
}

Back to Top