Skip to main content
PATCH
/
org
/
{org}
/
gvc
/
{gvc}
/
identity
/
{name}
Perform a Patch on an identity by name
curl --request PATCH \
  --url https://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "$drop": [
    "description"
  ],
  "name": "<string>",
  "description": "<string>",
  "tags": {},
  "$replace/tags": {},
  "aws": {
    "$drop": [
      "cloudAccountLink"
    ],
    "cloudAccountLink": "<string>",
    "policyRefs": [
      "<string>"
    ],
    "$drop/policyRefs": [
      "<string>"
    ],
    "$append/policyRefs": [
      "<string>"
    ],
    "$retain/policyRefs": [
      "<string>"
    ],
    "trustPolicy": {
      "$drop": [
        "Version"
      ],
      "Version": "2012-10-17",
      "Statement": [
        {}
      ],
      "$drop/Statement": [
        "<string>"
      ],
      "$append/Statement": [
        {}
      ],
      "$patch/Statement": [
        {}
      ],
      "$retain/Statement": [
        "<string>"
      ]
    },
    "$replace/trustPolicy": {
      "Version": "2012-10-17",
      "Statement": [
        {}
      ]
    },
    "roleName": "<string>"
  },
  "$replace/aws": {
    "cloudAccountLink": "<string>",
    "policyRefs": [
      "<string>"
    ],
    "trustPolicy": {
      "Version": "2012-10-17",
      "Statement": [
        {}
      ]
    },
    "roleName": "<string>"
  },
  "gcp": {
    "$drop": [
      "cloudAccountLink"
    ],
    "cloudAccountLink": "<string>",
    "scopes": [
      "<string>"
    ],
    "$drop/scopes": [
      "<string>"
    ],
    "$append/scopes": [
      "<string>"
    ],
    "$retain/scopes": [
      "<string>"
    ],
    "serviceAccount": "<string>",
    "bindings": [
      {
        "resource": "<string>",
        "roles": [
          "<string>"
        ]
      }
    ],
    "$drop/bindings": [
      "<string>"
    ],
    "$append/bindings": [
      {
        "resource": "<string>",
        "roles": [
          "<string>"
        ]
      }
    ],
    "$patch/bindings": [
      {
        "$drop": [
          "resource"
        ],
        "resource": "<string>",
        "roles": [
          "<string>"
        ],
        "$drop/roles": [
          "<string>"
        ],
        "$append/roles": [
          "<string>"
        ],
        "$retain/roles": [
          "<string>"
        ]
      }
    ],
    "$retain/bindings": [
      "<string>"
    ]
  },
  "$replace/gcp": {
    "cloudAccountLink": "<string>",
    "scopes": [
      "<string>"
    ],
    "serviceAccount": "<string>",
    "bindings": [
      {
        "resource": "<string>",
        "roles": [
          "<string>"
        ]
      }
    ]
  },
  "azure": {
    "$drop": [
      "cloudAccountLink"
    ],
    "cloudAccountLink": "<string>",
    "roleAssignments": [
      {
        "scope": "<string>",
        "roles": [
          "<string>"
        ]
      }
    ],
    "$drop/roleAssignments": [
      "<string>"
    ],
    "$append/roleAssignments": [
      {
        "scope": "<string>",
        "roles": [
          "<string>"
        ]
      }
    ],
    "$patch/roleAssignments": [
      {
        "$drop": [
          "scope"
        ],
        "scope": "<string>",
        "roles": [
          "<string>"
        ],
        "$drop/roles": [
          "<string>"
        ],
        "$append/roles": [
          "<string>"
        ],
        "$retain/roles": [
          "<string>"
        ]
      }
    ],
    "$retain/roleAssignments": [
      "<string>"
    ]
  },
  "$replace/azure": {
    "cloudAccountLink": "<string>",
    "roleAssignments": [
      {
        "scope": "<string>",
        "roles": [
          "<string>"
        ]
      }
    ]
  },
  "ngs": {
    "$drop": [
      "cloudAccountLink"
    ],
    "cloudAccountLink": "<string>",
    "pub": {
      "$drop": [
        "allow"
      ],
      "allow": [
        "<string>"
      ],
      "$drop/allow": [
        "<string>"
      ],
      "$append/allow": [
        "<string>"
      ],
      "$retain/allow": [
        "<string>"
      ],
      "deny": [
        "<string>"
      ],
      "$drop/deny": [
        "<string>"
      ],
      "$append/deny": [
        "<string>"
      ],
      "$retain/deny": [
        "<string>"
      ]
    },
    "$replace/pub": {
      "allow": [
        "<string>"
      ],
      "deny": [
        "<string>"
      ]
    },
    "sub": {
      "$drop": [
        "allow"
      ],
      "allow": [
        "<string>"
      ],
      "$drop/allow": [
        "<string>"
      ],
      "$append/allow": [
        "<string>"
      ],
      "$retain/allow": [
        "<string>"
      ],
      "deny": [
        "<string>"
      ],
      "$drop/deny": [
        "<string>"
      ],
      "$append/deny": [
        "<string>"
      ],
      "$retain/deny": [
        "<string>"
      ]
    },
    "$replace/sub": {
      "allow": [
        "<string>"
      ],
      "deny": [
        "<string>"
      ]
    },
    "resp": {
      "$drop": [
        "max"
      ],
      "max": 123,
      "ttl": "<string>"
    },
    "$replace/resp": {
      "max": 123,
      "ttl": "<string>"
    },
    "subs": 123,
    "data": 123,
    "payload": 123
  },
  "$replace/ngs": {
    "cloudAccountLink": "<string>",
    "pub": {
      "allow": [
        "<string>"
      ],
      "deny": [
        "<string>"
      ]
    },
    "sub": {
      "allow": [
        "<string>"
      ],
      "deny": [
        "<string>"
      ]
    },
    "resp": {
      "max": 123,
      "ttl": "<string>"
    },
    "subs": 123,
    "data": 123,
    "payload": 123
  },
  "networkResources": [
    {
      "name": "<string>",
      "agentLink": "<string>",
      "IPs": [
        "<string>"
      ],
      "FQDN": "<string>",
      "resolverIP": "<string>",
      "ports": [
        123
      ]
    }
  ],
  "$drop/networkResources": [
    "<string>"
  ],
  "$append/networkResources": [
    {
      "name": "<string>",
      "agentLink": "<string>",
      "IPs": [
        "<string>"
      ],
      "FQDN": "<string>",
      "resolverIP": "<string>",
      "ports": [
        123
      ]
    }
  ],
  "$retain/networkResources": [
    "<string>"
  ],
  "$patch/networkResources": [
    {
      "$drop": [
        "agentLink"
      ],
      "$replace/name": "<string>",
      "name": "<unknown>",
      "agentLink": "<string>",
      "IPs": [
        "<string>"
      ],
      "$drop/IPs": [
        "<string>"
      ],
      "$append/IPs": [
        "<string>"
      ],
      "$retain/IPs": [
        "<string>"
      ],
      "FQDN": "<string>",
      "resolverIP": "<string>",
      "ports": [
        123
      ],
      "$drop/ports": [
        123
      ],
      "$append/ports": [
        123
      ],
      "$retain/ports": [
        123
      ]
    }
  ],
  "nativeNetworkResources": [
    {
      "name": "<string>",
      "FQDN": "<string>",
      "ports": [
        123
      ],
      "awsPrivateLink": {
        "endpointServiceName": "<string>"
      },
      "gcpServiceConnect": {
        "targetService": "<string>"
      }
    }
  ],
  "$drop/nativeNetworkResources": [
    "<string>"
  ],
  "$append/nativeNetworkResources": [
    {
      "name": "<string>",
      "FQDN": "<string>",
      "ports": [
        123
      ],
      "awsPrivateLink": {
        "endpointServiceName": "<string>"
      },
      "gcpServiceConnect": {
        "targetService": "<string>"
      }
    }
  ],
  "$patch/nativeNetworkResources": [
    {
      "$drop": [
        "FQDN"
      ],
      "$replace/name": "<string>",
      "name": "<unknown>",
      "FQDN": "<string>",
      "ports": [
        123
      ],
      "$drop/ports": [
        123
      ],
      "$append/ports": [
        123
      ],
      "$retain/ports": [
        123
      ],
      "awsPrivateLink": {
        "$drop": [
          "endpointServiceName"
        ],
        "endpointServiceName": "<string>"
      },
      "$replace/awsPrivateLink": {
        "endpointServiceName": "<string>"
      },
      "gcpServiceConnect": {
        "$drop": [
          "targetService"
        ],
        "targetService": "<string>"
      },
      "$replace/gcpServiceConnect": {
        "targetService": "<string>"
      }
    }
  ],
  "$retain/nativeNetworkResources": [
    "<string>"
  ],
  "memcacheAccess": [
    {
      "clusterLink": "<string>",
      "role": "readWrite"
    }
  ],
  "$drop/memcacheAccess": [
    "<string>"
  ],
  "$append/memcacheAccess": [
    {
      "clusterLink": "<string>",
      "role": "readWrite"
    }
  ],
  "$patch/memcacheAccess": [
    {
      "$drop": [
        "clusterLink"
      ],
      "clusterLink": "<string>",
      "role": "readWrite"
    }
  ],
  "$retain/memcacheAccess": [
    "<string>"
  ],
  "spicedbAccess": [
    {
      "clusterLink": "<string>",
      "role": "checkPermission"
    }
  ],
  "$drop/spicedbAccess": [
    "<string>"
  ],
  "$append/spicedbAccess": [
    {
      "clusterLink": "<string>",
      "role": "checkPermission"
    }
  ],
  "$patch/spicedbAccess": [
    {
      "$drop": [
        "clusterLink"
      ],
      "clusterLink": "<string>",
      "role": "checkPermission"
    }
  ],
  "$retain/spicedbAccess": [
    "<string>"
  ],
  "gvc": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "kind": "<string>",
  "version": 123,
  "description": "<string>",
  "tags": {},
  "created": "2023-11-07T05:31:56Z",
  "lastModified": "2023-11-07T05:31:56Z",
  "links": [
    {
      "rel": "<string>",
      "href": "<string>"
    }
  ],
  "aws": {
    "cloudAccountLink": "<string>",
    "policyRefs": [
      "<string>"
    ],
    "trustPolicy": {
      "Version": "2012-10-17",
      "Statement": [
        {}
      ]
    },
    "roleName": "<string>"
  },
  "gcp": {
    "cloudAccountLink": "<string>",
    "scopes": [
      "<string>"
    ],
    "serviceAccount": "<string>",
    "bindings": [
      {
        "resource": "<string>",
        "roles": [
          "<string>"
        ]
      }
    ]
  },
  "azure": {
    "cloudAccountLink": "<string>",
    "roleAssignments": [
      {
        "scope": "<string>",
        "roles": [
          "<string>"
        ]
      }
    ]
  },
  "ngs": {
    "cloudAccountLink": "<string>",
    "pub": {
      "allow": [
        "<string>"
      ],
      "deny": [
        "<string>"
      ]
    },
    "sub": {
      "allow": [
        "<string>"
      ],
      "deny": [
        "<string>"
      ]
    },
    "resp": {
      "max": 123,
      "ttl": "<string>"
    },
    "subs": 123,
    "data": 123,
    "payload": 123
  },
  "networkResources": [
    {
      "name": "<string>",
      "agentLink": "<string>",
      "IPs": [
        "<string>"
      ],
      "FQDN": "<string>",
      "resolverIP": "<string>",
      "ports": [
        123
      ]
    }
  ],
  "nativeNetworkResources": [
    {
      "name": "<string>",
      "FQDN": "<string>",
      "ports": [
        123
      ],
      "awsPrivateLink": {
        "endpointServiceName": "<string>"
      },
      "gcpServiceConnect": {
        "targetService": "<string>"
      }
    }
  ],
  "memcacheAccess": [
    {
      "clusterLink": "<string>",
      "role": "readWrite"
    }
  ],
  "spicedbAccess": [
    {
      "clusterLink": "<string>",
      "role": "checkPermission"
    }
  ],
  "status": {
    "objectName": "<string>",
    "aws": {
      "lastError": "<string>",
      "usable": true
    },
    "gcp": {
      "lastError": "<string>",
      "usable": true
    },
    "azure": {
      "lastError": "<string>",
      "usable": true
    }
  },
  "gvc": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.controlplane.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Service account key can be used as API keys

Path Parameters

org
string
required
gvc
string
required
name
string
required

Body

application/json
$drop
enum<string>[]
Available options:
description,
tags,
aws,
gcp,
azure,
ngs,
networkResources,
nativeNetworkResources,
memcacheAccess,
spicedbAccess,
gvc
name
string
Maximum string length: 64
description
string
Maximum string length: 250
tags
object
$replace/tags
object
aws
object
$replace/aws
object
gcp
object
$replace/gcp
object
azure
object
$replace/azure
object
ngs
object
$replace/ngs
object
networkResources
object[]
$drop/networkResources
string[]
$append/networkResources
object[]
$retain/networkResources
string[]
$patch/networkResources
object[]
nativeNetworkResources
object[]
$drop/nativeNetworkResources
string[]
$append/nativeNetworkResources
object[]
$patch/nativeNetworkResources
object[]
$retain/nativeNetworkResources
string[]
memcacheAccess
object[]
$drop/memcacheAccess
string[]
$append/memcacheAccess
object[]
$patch/memcacheAccess
object[]
$retain/memcacheAccess
string[]
spicedbAccess
object[]
$drop/spicedbAccess
string[]
$append/spicedbAccess
object[]
$patch/spicedbAccess
object[]
$retain/spicedbAccess
string[]
gvc
string

Response

Success

id
string
read-only
name
string
Maximum string length: 64
kind
string
read-only
version
integer
read-only
description
string
Maximum string length: 250
tags
object
created
string<date-time>
read-only
lastModified
string<date-time>
read-only
aws
object
gcp
object
azure
object
ngs
object
networkResources
object[]
nativeNetworkResources
object[]
memcacheAccess
object[]
spicedbAccess
object[]
status
object
read-only
gvc
string