List Organizational Units

Returns a list of organizational units.

Query Parameters

limit int64
Limits the size of the response on each page to the specified number of items.
start string
Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).

filter string

Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

Field	Filter Condition	Description
parent_id	$eq	Retrieve the list of child OUs under this organizational unit.
name	$contains	A substring of the name of the organizational unit.
id	$in	Filter OUs whose ID is one of the given values.

For more information about filtering, refer to the Filtering section of this guide.

Responses

200
default

Success

application/api.clumio.organizational-units=v2+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
items object[]
A collection of requested items.
_embedded object
Embedded responses related to the resource.
read-task Embeds the associated task of a resource in the response if requested using the `embed` query parameter.
Embeds the associated task of a resource in the response if requested using the embed query parameter.
_etag string
ETag value
_links object
URLs to pages related to the resource.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
delete-organizational-unit object
A resource-specific HATEOAS link.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
patch-organizational-unit object
A resource-specific HATEOAS link.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
read-task object
A resource-specific HATEOAS link.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
children_count int64
Number of immediate children of the organizational unit.
configured_datasource_types string[]
Datasource types configured in this organizational unit. Possible values include aws, microsoft365, vmware, or mssql.
descendant_ids string[]
List of all recursive descendant organizational units of this OU.
description string
A description of the organizational unit.
id string
The Clumio assigned ID of the organizational unit.
name string
Unique name assigned to the organizational unit.
parent_id string
The Clumio assigned ID of the parent organizational unit. The parent organizational unit contains the entities in this organizational unit and can update this organizational unit. If this organizational unit is the global organizational unit, then this field has a value of null.
task_id string
The Clumio-assigned ID of the task associated with this organizational unit. The progress of the task can be monitored using the GET /tasks/{task_id} endpoint.
user_count int64
Number of users to whom this organizational unit or any of its descendants have been assigned.
users object[]
Users IDs to whom the organizational unit has been assigned. This attribute will be available when reading a single OU and not when listing OUs.
assigned_role uuid4
The Clumio-assigned ID of the role to be assigned to the user.
user_id string
The ID of the user.
_links object
URLs to pages related to the resource.
_first object
The HATEOAS link to the first page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_last object
The HATEOAS link to the last page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_next object
The HATEOAS link to the next page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_prev object
The HATEOAS link to the previous page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
current_count int64
The number of items listed on the current page.
filter_applied string
The filter used in the request. The filter includes both manually-specified and system-generated filters.
limit int64
The maximum number of items displayed per page in the response.
start string
The page number used to get this response. Pages are indexed starting from 1 (i.e., "start": "1").
total_count int64
The total number of items, summed across all pages.
total_pages_count int64
The total number of pages of results.

{
  "_embedded": {
    "items": [
      {
        "_embedded": {},
        "_etag": "string",
        "_links": {
          "_self": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "delete-organizational-unit": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "patch-organizational-unit": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "read-task": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "children_count": 0,
        "configured_datasource_types": [
          "string"
        ],
        "descendant_ids": [
          "string"
        ],
        "description": "string",
        "id": "string",
        "name": "string",
        "parent_id": "string",
        "task_id": "string",
        "user_count": 0,
        "users": [
          {
            "assigned_role": "string",
            "user_id": "string"
          }
        ]
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_last": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_prev": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "filter_applied": "string",
  "limit": 0,
  "start": "string",
  "total_count": 0,
  "total_pages_count": 0
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

GET /organizational-units

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

limit — query

start — query

filter — query

curl -L -X GET 'https://us-west-2.api.clumio.com/organizational-units' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/organizational-units' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/organizational-units' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/organizational-units' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/organizational-units' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/organizational-units' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/organizational-units' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'