Patch Organizational Unit

deprecated

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

Patch the specified organizational unit. The complete updated attribute(s) of the organizational unit must be provided in the request. Adding or removing entities from the OU is an asynchronous operation and has an associated task. When the request has entities to be added or removed, the response contains a task ID that can be used to track the progress of the operation.

Path Parameters

id string required
Patch 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 Link Description
read-task Embeds 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.

Embeddable Link	Description
read-task	Embeds the associated task in the response. For example, `?embed=read-task`

application/json

Request Body

description string
Possible values: <= 129 characters
A description of the organizational unit.
entities object
Updates to the entities in the organizational unit. Adding or removing entities from the OU is an asynchronous operation. The response has a task ID which can be used to track the progress of the operation.
add object[]
List of entities to add to the organizational unit.
parent_entity object
The parent object of the primary entity associated with the organizational unit. The parent object is optional and can be omitted.
id string
The Clumio assigned ID of the entity.
type string
Possible values: [aws_environment, microsoft365_domain, azure_ad_domain]
The entity type.
primary_entity object
The primary object associated with the organizational unit. Examples of primary entities include "aws_environment".
id string
The Clumio assigned ID of the entity.
type string
Possible values: [aws_environment, microsoft365_domain, azure_ad_domain]
The entity type.
remove object[]
List of entities to remove from the organizational unit.
parent_entity object
The parent object of the primary entity associated with the organizational unit. The parent object is optional and can be omitted.
id string
The Clumio assigned ID of the entity.
type string
Possible values: [aws_environment, microsoft365_domain, azure_ad_domain]
The entity type.
primary_entity object
The primary object associated with the organizational unit. Examples of primary entities include "aws_environment".
id string
The Clumio assigned ID of the entity.
type string
Possible values: [aws_environment, microsoft365_domain, azure_ad_domain]
The entity type.
name string
Possible values: non-empty and <= 129 characters
Unique name assigned to the organizational unit.
users object
Updates to the user assignments.
add string[]
List of user IDs to assign this organizational unit.
remove string[]
List of user IDs to un-assign this organizational unit.

Responses

200
202
default

Success

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

Schema
Example (from schema)

Schema

_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.
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.
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.

{
  "_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"
    }
  },
  "children_count": 0,
  "configured_datasource_types": [
    "string"
  ],
  "descendant_ids": [
    "string"
  ],
  "description": "string",
  "id": "string",
  "name": "string",
  "parent_id": "string",
  "user_count": 0,
  "users": [
    "string"
  ]
}

Accepted

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

Schema
Example (from schema)

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.
_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.

{
  "_embedded": {},
  "_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": [
    "string"
  ]
}

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"
    }
  ]
}

PATCH /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

Body

{
  "description": "string",
  "entities": {
    "add": [
      {
        "parent_entity": {
          "id": "string",
          "type": "aws_environment"
        },
        "primary_entity": {
          "id": "string",
          "type": "aws_environment"
        }
      }
    ],
    "remove": [
      {
        "parent_entity": {
          "id": "string",
          "type": "aws_environment"
        },
        "primary_entity": {
          "id": "string",
          "type": "aws_environment"
        }
      }
    ]
  },
  "name": "string",
  "users": {
    "add": [
      "string"
    ],
    "remove": [
      "string"
    ]
  }
}

Accept

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

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

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

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

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

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

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