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": [],
"name": "<string>",
"description": "<string>",
"tags": {},
"$replace/tags": {},
"aws": {
"$drop": [],
"cloudAccountLink": "<string>",
"policyRefs": [
"<string>"
],
"$drop/policyRefs": [
"<string>"
],
"$append/policyRefs": [
"<string>"
],
"$retain/policyRefs": [
"<string>"
],
"trustPolicy": {
"$drop": [],
"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": "<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": "<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": "<string>",
"roleAssignments": [
{
"scope": "<string>",
"roles": [
"<string>"
]
}
],
"$drop/roleAssignments": [
"<string>"
],
"$append/roleAssignments": [
{
"scope": "<string>",
"roles": [
"<string>"
]
}
],
"$patch/roleAssignments": [
{
"$drop": [],
"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": "<string>",
"pub": {
"$drop": [],
"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": [
"<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": 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": [],
"$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": [],
"$replace/name": "<string>",
"name": "<unknown>",
"FQDN": "<string>",
"ports": [
123
],
"$drop/ports": [
123
],
"$append/ports": [
123
],
"$retain/ports": [
123
],
"awsPrivateLink": {
"$drop": [],
"endpointServiceName": "<string>"
},
"$replace/awsPrivateLink": {
"endpointServiceName": "<string>"
},
"gcpServiceConnect": {
"$drop": [],
"targetService": "<string>"
},
"$replace/gcpServiceConnect": {
"targetService": "<string>"
}
}
],
"$retain/nativeNetworkResources": [
"<string>"
],
"memcacheAccess": [
{
"clusterLink": "<string>"
}
],
"$drop/memcacheAccess": [
"<string>"
],
"$append/memcacheAccess": [
{
"clusterLink": "<string>"
}
],
"$patch/memcacheAccess": [
{
"$drop": [],
"clusterLink": "<string>"
}
],
"$retain/memcacheAccess": [
"<string>"
],
"spicedbAccess": [
{
"clusterLink": "<string>"
}
],
"$drop/spicedbAccess": [
"<string>"
],
"$append/spicedbAccess": [
{
"clusterLink": "<string>"
}
],
"$patch/spicedbAccess": [
{
"$drop": [],
"clusterLink": "<string>"
}
],
"$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>"
}
],
"spicedbAccess": [
{
"clusterLink": "<string>"
}
],
"status": {
"objectName": "<string>",
"aws": {
"lastError": "<string>",
"usable": true
},
"gcp": {
"lastError": "<string>",
"usable": true
},
"azure": {
"lastError": "<string>",
"usable": true
}
},
"gvc": "<string>"
}Identity
Perform a Patch on an identity by name
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": [],
"name": "<string>",
"description": "<string>",
"tags": {},
"$replace/tags": {},
"aws": {
"$drop": [],
"cloudAccountLink": "<string>",
"policyRefs": [
"<string>"
],
"$drop/policyRefs": [
"<string>"
],
"$append/policyRefs": [
"<string>"
],
"$retain/policyRefs": [
"<string>"
],
"trustPolicy": {
"$drop": [],
"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": "<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": "<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": "<string>",
"roleAssignments": [
{
"scope": "<string>",
"roles": [
"<string>"
]
}
],
"$drop/roleAssignments": [
"<string>"
],
"$append/roleAssignments": [
{
"scope": "<string>",
"roles": [
"<string>"
]
}
],
"$patch/roleAssignments": [
{
"$drop": [],
"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": "<string>",
"pub": {
"$drop": [],
"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": [
"<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": 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": [],
"$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": [],
"$replace/name": "<string>",
"name": "<unknown>",
"FQDN": "<string>",
"ports": [
123
],
"$drop/ports": [
123
],
"$append/ports": [
123
],
"$retain/ports": [
123
],
"awsPrivateLink": {
"$drop": [],
"endpointServiceName": "<string>"
},
"$replace/awsPrivateLink": {
"endpointServiceName": "<string>"
},
"gcpServiceConnect": {
"$drop": [],
"targetService": "<string>"
},
"$replace/gcpServiceConnect": {
"targetService": "<string>"
}
}
],
"$retain/nativeNetworkResources": [
"<string>"
],
"memcacheAccess": [
{
"clusterLink": "<string>"
}
],
"$drop/memcacheAccess": [
"<string>"
],
"$append/memcacheAccess": [
{
"clusterLink": "<string>"
}
],
"$patch/memcacheAccess": [
{
"$drop": [],
"clusterLink": "<string>"
}
],
"$retain/memcacheAccess": [
"<string>"
],
"spicedbAccess": [
{
"clusterLink": "<string>"
}
],
"$drop/spicedbAccess": [
"<string>"
],
"$append/spicedbAccess": [
{
"clusterLink": "<string>"
}
],
"$patch/spicedbAccess": [
{
"$drop": [],
"clusterLink": "<string>"
}
],
"$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>"
}
],
"spicedbAccess": [
{
"clusterLink": "<string>"
}
],
"status": {
"objectName": "<string>",
"aws": {
"lastError": "<string>",
"usable": true
},
"gcp": {
"lastError": "<string>",
"usable": true
},
"azure": {
"lastError": "<string>",
"usable": true
}
},
"gvc": "<string>"
}Authorizations
serviceAccountKeyjwt
Service account key can be used as API keys
Body
application/json
Available options:
description, tags, aws, gcp, azure, ngs, networkResources, nativeNetworkResources, memcacheAccess, spicedbAccess, gvc Maximum string length:
64Maximum string length:
250Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Success
Maximum string length:
64Maximum string length:
250Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I