List Organizations for a User

get

/api/v2/users/{id}/organizations/

Make a GET request to this resource to retrieve a list of organizations associated with the selected user.

The resulting data structure contains:

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

The count field indicates the total number of organizations 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 organization records.

Results

Each organization data structure includes the following fields:

  • id: Database ID for this organization. (integer)
  • type: Data type for this organization. (choice)
  • url: URL for this organization. (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 organization was created. (datetime)
  • modified: Timestamp when this organization was last modified. (datetime)
  • name: Name of this organization. (string)
  • description: Optional description of this organization. (string)
  • max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer)
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
  • default_environment: The default execution environment for jobs run by this organization. (id)

Sorting

To specify that organizations 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 Oracle Linux Automation Manaer) Search across related fields:

?related__search=findme

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

200 Response

Back to Top