Update an Organization
put
/api/v2/organizations/{id}/
Make a PUT or PATCH request to this resource to update this organization. The following fields may be modified:
name: Name of this organization. (string, required)description: Optional description of this organization. (string, default="")max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer, default=0)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default="")
For a PUT request, include all fields in the request.
Request
Supported Media Types
- application/json
Path Parameters
Query Parameters
-
search(optional): string
A search term.
Root Schema : schema
Example:
{
"created":"2018-02-01T08:00:00.000000Z",
"custom_virtualenv":null,
"description":"test-org-desc",
"id":1,
"max_hosts":3,
"modified":"2018-02-01T08:00:00.000000Z",
"name":"test-org",
"related":{
"access_list":"/api/v2/organizations/1/access_list/",
"activity_stream":"/api/v2/organizations/1/activity_stream/",
"admins":"/api/v2/organizations/1/admins/",
"applications":"/api/v2/organizations/1/applications/",
"credentials":"/api/v2/organizations/1/credentials/",
"galaxy_credentials":"/api/v2/organizations/1/galaxy_credentials/",
"instance_groups":"/api/v2/organizations/1/instance_groups/",
"inventories":"/api/v2/organizations/1/inventories/",
"job_templates":"/api/v2/organizations/1/job_templates/",
"notification_templates":"/api/v2/organizations/1/notification_templates/",
"notification_templates_approvals":"/api/v2/organizations/1/notification_templates_approvals/",
"notification_templates_error":"/api/v2/organizations/1/notification_templates_error/",
"notification_templates_started":"/api/v2/organizations/1/notification_templates_started/",
"notification_templates_success":"/api/v2/organizations/1/notification_templates_success/",
"object_roles":"/api/v2/organizations/1/object_roles/",
"projects":"/api/v2/organizations/1/projects/",
"teams":"/api/v2/organizations/1/teams/",
"users":"/api/v2/organizations/1/users/",
"workflow_job_templates":"/api/v2/organizations/1/workflow_job_templates/"
},
"summary_fields":{
"object_roles":{
"admin_role":{
"description":"Can manage all aspects of the organization",
"id":1,
"name":"Admin",
"user_only":true
},
"approval_role":{
"description":"Can approve or deny a workflow approval node",
"id":12,
"name":"Approve"
},
"auditor_role":{
"description":"Can view all aspects of the organization",
"id":9,
"name":"Auditor"
},
"credential_admin_role":{
"description":"Can manage all credentials of the organization",
"id":5,
"name":"Credential Admin"
},
"execute_role":{
"description":"May run any executable resources in the organization",
"id":2,
"name":"Execute"
},
"inventory_admin_role":{
"description":"Can manage all inventories of the organization",
"id":4,
"name":"Inventory Admin"
},
"job_template_admin_role":{
"description":"Can manage all job templates of the organization",
"id":8,
"name":"Job Template Admin"
},
"member_role":{
"description":"User is a member of the organization",
"id":10,
"name":"Member",
"user_only":true
},
"notification_admin_role":{
"description":"Can manage all notifications of the organization",
"id":7,
"name":"Notification Admin"
},
"project_admin_role":{
"description":"Can manage all projects of the organization",
"id":3,
"name":"Project Admin"
},
"read_role":{
"description":"May view settings for the organization",
"id":11,
"name":"Read"
},
"workflow_admin_role":{
"description":"Can manage all workflows of the organization",
"id":6,
"name":"Workflow Admin"
}
},
"related_field_counts":{
"admins":0,
"inventories":0,
"job_templates":0,
"projects":0,
"teams":0,
"users":0
},
"user_capabilities":{
"delete":true,
"edit":true
}
},
"type":"organization",
"url":"/api/v2/organizations/1/"
}Response
Supported Media Types
- application/json
200 Response
Example Response (application/json)
{
"created":"2018-02-01T08:00:00.000000Z",
"custom_virtualenv":null,
"description":"test-org-desc",
"id":1,
"max_hosts":3,
"modified":"2018-02-01T08:00:00.000000Z",
"name":"test-org",
"related":{
"access_list":"/api/v2/organizations/1/access_list/",
"activity_stream":"/api/v2/organizations/1/activity_stream/",
"admins":"/api/v2/organizations/1/admins/",
"applications":"/api/v2/organizations/1/applications/",
"credentials":"/api/v2/organizations/1/credentials/",
"galaxy_credentials":"/api/v2/organizations/1/galaxy_credentials/",
"instance_groups":"/api/v2/organizations/1/instance_groups/",
"inventories":"/api/v2/organizations/1/inventories/",
"job_templates":"/api/v2/organizations/1/job_templates/",
"notification_templates":"/api/v2/organizations/1/notification_templates/",
"notification_templates_approvals":"/api/v2/organizations/1/notification_templates_approvals/",
"notification_templates_error":"/api/v2/organizations/1/notification_templates_error/",
"notification_templates_started":"/api/v2/organizations/1/notification_templates_started/",
"notification_templates_success":"/api/v2/organizations/1/notification_templates_success/",
"object_roles":"/api/v2/organizations/1/object_roles/",
"projects":"/api/v2/organizations/1/projects/",
"teams":"/api/v2/organizations/1/teams/",
"users":"/api/v2/organizations/1/users/",
"workflow_job_templates":"/api/v2/organizations/1/workflow_job_templates/"
},
"summary_fields":{
"object_roles":{
"admin_role":{
"description":"Can manage all aspects of the organization",
"id":1,
"name":"Admin",
"user_only":true
},
"approval_role":{
"description":"Can approve or deny a workflow approval node",
"id":12,
"name":"Approve"
},
"auditor_role":{
"description":"Can view all aspects of the organization",
"id":9,
"name":"Auditor"
},
"credential_admin_role":{
"description":"Can manage all credentials of the organization",
"id":5,
"name":"Credential Admin"
},
"execute_role":{
"description":"May run any executable resources in the organization",
"id":2,
"name":"Execute"
},
"inventory_admin_role":{
"description":"Can manage all inventories of the organization",
"id":4,
"name":"Inventory Admin"
},
"job_template_admin_role":{
"description":"Can manage all job templates of the organization",
"id":8,
"name":"Job Template Admin"
},
"member_role":{
"description":"User is a member of the organization",
"id":10,
"name":"Member",
"user_only":true
},
"notification_admin_role":{
"description":"Can manage all notifications of the organization",
"id":7,
"name":"Notification Admin"
},
"project_admin_role":{
"description":"Can manage all projects of the organization",
"id":3,
"name":"Project Admin"
},
"read_role":{
"description":"May view settings for the organization",
"id":11,
"name":"Read"
},
"workflow_admin_role":{
"description":"Can manage all workflows of the organization",
"id":6,
"name":"Workflow Admin"
}
},
"related_field_counts":{
"admins":0,
"inventories":0,
"job_templates":0,
"projects":0,
"teams":0,
"users":0
},
"user_capabilities":{
"delete":true,
"edit":true
}
},
"type":"organization",
"url":"/api/v2/organizations/1/"
}400 Response
Example Response (application/json)
{
"__all__":[
"Cannot change max_hosts."
]
}403 Response
Example Response (application/json)
{
"detail":"You do not have permission to perform this action."
}