Skip to main content

Retrieve an Organizational Unit

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Returns a representation of the specified organizational unit.

Path Parameters
  • id string required

    Retrieve the organizational unit with the specified ID.

Query Parameters
  • embed string

    Embeds the details of each associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.

    Embeddable LinkDescription
    read-taskEmbeds the associated task in the response. For example, ?embed=read-task
    For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.
Responses

Success


Schema
  • _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 string[]

    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.

GET /organizational-units/:id-v1    

Authorization

Request

Click Edit to configure Base URL
https://us-west-2.api.clumio.com
Bearer Token
id — path required
embed — query
curl -L -X GET 'https://us-west-2.api.clumio.com' \
-H 'Accept: application/api.clumio.organizational-units=v1+json' \
-H 'Authorization: Bearer <TOKEN>'