1. Oracle Linux Automation Manager CLI and API Reference Guide
  2. Tasks
  3. Organizations

Retrieve an Organization

get

/api/v2/organizations/{id}/

Make GET request to this resource to retrieve a single organization record containing 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)

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "created":"2018-02-01T08:00:00.000000Z",
    "custom_virtualenv":"/venv/tmp_rpu6sg6/",
    "description":"test-org-desc",
    "id":1,
    "max_hosts":0,
    "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/"
}

401 Response

Body
Example Response (application/json)
{
    "detail":"Authentication credentials were not provided. To establish a login session, visit /api/login/."
}

403 Response

Body
Example Response (application/json)
{
    "detail":"You do not have permission to perform this action."
}
Back to Top