updateOrgUnitHierarchy

Examples

GraphQL

mutation UpdateOrgUnitHierarchy($orgUnitHierarchyInput: OrgUnitHierarchyInput!) {
  updateOrgUnitHierarchy(orgUnitHierarchyInput: $orgUnitHierarchyInput) {
    name
    tagIds
    tags {
      tagId
      name
      displayName
      tagType
      createdBy
      createdAt
      updatedAt
      tagCategory
      deploymentModel
      purpose
      email
    }
    appOwnersEmail
    id
    parent
    ancestors {
      id
      name
    }
    children {
      name
      tagIds
      tags {
        tagId
        name
        displayName
        tagType
        createdBy
        createdAt
        updatedAt
        tagCategory
        deploymentModel
        purpose
        email
      }
      appOwnersEmail
      id
      parent
      ancestors {
        id
        name
      }
      children {
        name
        tagIds
        tags {
          tagId
          name
          displayName
          tagType
          createdBy
          createdAt
          updatedAt
          tagCategory
          deploymentModel
          purpose
          email
        }
        appOwnersEmail
        id
        parent
        ancestors {
          id
          name
        }
      }
    }
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "orgUnitHierarchyInput": {
    "orgUnitHierarchy": [
      {
        "name": "SomeName",
        "tagIds": ["example"],
        "appOwnersEmail": ["example"],
        "id": "example",
        "parent": "example",
        "children": [
          {
            "name": "SomeName",
            "tagIds": [],
            "appOwnersEmail": [],
            "id": "example",
            "parent": "example",
            "children": []
          }
        ]
      }
    ],
    "owners": ["example"],
    "tagIds": ["example"]
  }
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "mutation UpdateOrgUnitHierarchy($orgUnitHierarchyInput: OrgUnitHierarchyInput!) { updateOrgUnitHierarchy(orgUnitHierarchyInput: $orgUnitHierarchyInput) { name tagIds tags { tagId name displayName tagType createdBy createdAt updatedAt tagCategory deploymentModel purpose email } appOwnersEmail id parent ancestors { id name } children { name tagIds tags { tagId name displayName tagType createdBy createdAt updatedAt tagCategory deploymentModel purpose email } appOwnersEmail id parent ancestors { id name } children { name tagIds tags { tagId name displayName tagType createdBy createdAt updatedAt tagCategory deploymentModel purpose email } appOwnersEmail id parent ancestors { id name } } } } }",
 "variables": {
    "orgUnitHierarchyInput": {
      "orgUnitHierarchy": [
        {
          "name": "SomeName",
          "tagIds": ["example"],
          "appOwnersEmail": ["example"],
          "id": "example",
          "parent": "example",
          "children": [
            {
              "name": "SomeName",
              "tagIds": [],
              "appOwnersEmail": [],
              "id": "example",
              "parent": "example",
              "children": []
            }
          ]
        }
      ],
      "owners": ["example"],
      "tagIds": ["example"]
    }
  }
}'

Node.js

const query = 'mutation UpdateOrgUnitHierarchy($orgUnitHierarchyInput: OrgUnitHierarchyInput!) { updateOrgUnitHierarchy(orgUnitHierarchyInput: $orgUnitHierarchyInput) { name tagIds tags { tagId name displayName tagType createdBy createdAt updatedAt tagCategory deploymentModel purpose email } appOwnersEmail id parent ancestors { id name } children { name tagIds tags { tagId name displayName tagType createdBy createdAt updatedAt tagCategory deploymentModel purpose email } appOwnersEmail id parent ancestors { id name } children { name tagIds tags { tagId name displayName tagType createdBy createdAt updatedAt tagCategory deploymentModel purpose email } appOwnersEmail id parent ancestors { id name } } } } }';

fetch("https://api.cloud.ox.security/api/apollo-gateway", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
    query: query,
    // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    variables: {
      orgUnitHierarchyInput: {
        orgUnitHierarchy: [
          {
            name: "SomeName",
            tagIds: ["example"],
            appOwnersEmail: ["example"],
            id: "example",
            parent: "example",
            children: [
              {
                name: "SomeName",
                tagIds: [],
                appOwnersEmail: [],
                id: "example",
                parent: "example",
                children: []
              }
            ]
          }
        ],
        owners: ["example"],
        tagIds: ["example"]
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'mutation UpdateOrgUnitHierarchy($orgUnitHierarchyInput: OrgUnitHierarchyInput!) { updateOrgUnitHierarchy(orgUnitHierarchyInput: $orgUnitHierarchyInput) { name tagIds tags { tagId name displayName tagType createdBy createdAt updatedAt tagCategory deploymentModel purpose email } appOwnersEmail id parent ancestors { id name } children { name tagIds tags { tagId name displayName tagType createdBy createdAt updatedAt tagCategory deploymentModel purpose email } appOwnersEmail id parent ancestors { id name } children { name tagIds tags { tagId name displayName tagType createdBy createdAt updatedAt tagCategory deploymentModel purpose email } appOwnersEmail id parent ancestors { id name } } } } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query,
    # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    "variables": {
      "orgUnitHierarchyInput": {
        "orgUnitHierarchy": [
          {
            "name": "SomeName",
            "tagIds": ["example"],
            "appOwnersEmail": ["example"],
            "id": "example",
            "parent": "example",
            "children": [
              {
                "name": "SomeName",
                "tagIds": [],
                "appOwnersEmail": [],
                "id": "example",
                "parent": "example",
                "children": []
              }
            ]
          }
        ],
        "owners": ["example"],
        "tagIds": ["example"]
      }
    }
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

Arguments

You can use the following argument(s) to customize your updateOrgUnitHierarchy mutation.

Argument	Description	Supported fields
orgUnitHierarchyInput OrgUnitHierarchyInput! required		orgUnitHierarchy [OrgUnitHierarchyItemInput!]! owners [String!] tagIds [String!]

Fields

Return type: [OrgUnitHierarchyItem!]

You can use the following field(s) to specify what information your updateOrgUnitHierarchy mutation will return. Please note that some fields may have their own subfields.

Field	Description	Supported fields
name String!
tagIds [String!]!
tags [TagObject!]!	Tags and app owners assigned to the organizational unit, resolved with their tag type. App owners are represented as tags with the owner tag type.	tagId String! name String! displayName String! tagType OxTagType! createdBy String! createdAt DateTime updatedAt DateTime tagCategory String deploymentModel String purpose String email String
appOwnersEmail [String!]
id String
parent String	Identifier of the current organizational unit, preserved for backward compatibility.
ancestors [OrgUnitRef!]!	Chain of ancestor organizational units ordered from the root down to the immediate parent. Empty when the unit is a root.	id String! name String!
children [OrgUnitHierarchyItem!]!		name String! tagIds [String!]! tags [TagObject!]! appOwnersEmail [String!] id String parent String ancestors [OrgUnitRef!]! children [OrgUnitHierarchyItem!]!