List Organizations
get
/api/v2/organizations/
Make a GET request to this resource to retrieve the list of organizations.
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
- application/json
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.
Response
Supported Media Types
- application/json
200 Response
Example Response (application/json)
{
"count":"1",
"next":null,
"previous":null,
"results":[
{
"created":"2018-02-01T08:00:00.000000Z",
"custom_virtualenv":null,
"default_environment":null,
"description":"test-org-desc",
"id":"2",
"max_hosts":"0",
"modified":"2018-02-01T08:00:00.000000Z",
"name":"test-org-1",
"related":{
"access_list":"/api/v2/organizations/2/access_list/",
"activity_stream":"/api/v2/organizations/2/activity_stream/",
"admins":"/api/v2/organizations/2/admins/",
"applications":"/api/v2/organizations/2/applications/",
"credentials":"/api/v2/organizations/2/credentials/",
"execution_environments":"/api/v2/organizations/2/execution_environments/",
"galaxy_credentials":"/api/v2/organizations/2/galaxy_credentials/",
"instance_groups":"/api/v2/organizations/2/instance_groups/",
"inventories":"/api/v2/organizations/2/inventories/",
"job_templates":"/api/v2/organizations/2/job_templates/",
"notification_templates":"/api/v2/organizations/2/notification_templates/",
"notification_templates_approvals":"/api/v2/organizations/2/notification_templates_approvals/",
"notification_templates_error":"/api/v2/organizations/2/notification_templates_error/",
"notification_templates_started":"/api/v2/organizations/2/notification_templates_started/",
"notification_templates_success":"/api/v2/organizations/2/notification_templates_success/",
"object_roles":"/api/v2/organizations/2/object_roles/",
"projects":"/api/v2/organizations/2/projects/",
"teams":"/api/v2/organizations/2/teams/",
"users":"/api/v2/organizations/2/users/",
"workflow_job_templates":"/api/v2/organizations/2/workflow_job_templates/"
},
"summary_fields":{
"object_roles":{
"admin_role":{
"description":"Can manage all aspects of the organization",
"id":"16",
"name":"Admin",
"user_only":true
},
"approval_role":{
"description":"Can approve or deny a workflow approval node",
"id":"28",
"name":"Approve"
},
"auditor_role":{
"description":"Can view all aspects of the organization",
"id":"25",
"name":"Auditor"
},
"credential_admin_role":{
"description":"Can manage all credentials of the organization",
"id":"20",
"name":"Credential Admin"
},
"execute_role":{
"description":"May run any executable resources in the organization",
"id":"17",
"name":"Execute"
},
"execution_environment_admin_role":{
"description":"Can manage all execution environments of the organization",
"id":"24",
"name":"Execution Environment Admin"
},
"inventory_admin_role":{
"description":"Can manage all inventories of the organization",
"id":"19",
"name":"Inventory Admin"
},
"job_template_admin_role":{
"description":"Can manage all job templates of the organization",
"id":"23",
"name":"Job Template Admin"
},
"member_role":{
"description":"User is a member of the organization",
"id":"26",
"name":"Member",
"user_only":true
},
"notification_admin_role":{
"description":"Can manage all notifications of the organization",
"id":"22",
"name":"Notification Admin"
},
"project_admin_role":{
"description":"Can manage all projects of the organization",
"id":"18",
"name":"Project Admin"
},
"read_role":{
"description":"May view settings for the organization",
"id":"27",
"name":"Read"
},
"workflow_admin_role":{
"description":"Can manage all workflows of the organization",
"id":"21",
"name":"Workflow Admin"
}
},
"related_field_counts":{
"admins":"0",
"inventories":"0",
"job_templates":"0",
"projects":"0",
"teams":"0",
"users":"1"
},
"user_capabilities":{
"delete":false,
"edit":false
}
},
"type":"organization",
"url":"/api/v2/organizations/2/"
}
]
}401 Response
Example Response (application/json)
{
"detail":"Authentication credentials were not provided. To establish a login session, visit /api/login/."
}